Skip to content
This repository has been archived by the owner on Mar 10, 2024. It is now read-only.

Configure known tags #16

Closed
bohoffi opened this issue Oct 5, 2022 · 1 comment · Fixed by #17
Closed

Configure known tags #16

bohoffi opened this issue Oct 5, 2022 · 1 comment · Fixed by #17
Assignees
@bohoffi
Labels
bug Something isn't working enhancement New feature or request
Milestone
1.0.0

Comments

@bohoffi
Copy link
Owner

bohoffi commented Oct 5, 2022

There's a limited set of extra tags configured using Dgenis parseTagsProcessor.

If a library contain its own set of tags deviating from the JSDoc standard the documentation generation will fail with the Tag "TAGNAME": Unknown tag. error message.

Generation options should be extended to give the possibility to define a set of known non JSDoc standard tags.
@bohoffi bohoffi self-assigned this Oct 5, 2022
@bohoffi bohoffi added this to the 1.0.0 milestone Oct 5, 2022
@bohoffi
Copy link
Owner Author

bohoffi commented Oct 8, 2022 •
edited
Loading

  • make docs-public tag configurable
  • make docs-private tag configurable
  • include breaking-change tag

@bohoffi bohoffi mentioned this issue Oct 26, 2022
Merged
1 task
@bohoffi bohoffi linked a pull request Oct 26, 2022 that will close this issue
Feature/16 configure known tags #17
Merged
1 task
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@bohoffi bohoffi

Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Milestone
1.0.0
Development

Successfully merging a pull request may close this issue.

Feature/16 configure known tags bohoffi/ngx-doc-gen
1 participant
@bohoffi