Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ignore comment types #47

Closed
aretecode opened this issue Jun 24, 2017 · 4 comments
Closed

ignore comment types #47

aretecode opened this issue Jun 24, 2017 · 4 comments

Comments

@aretecode
Copy link

it picks up non-doc blocks which can ruin the documentation when there are a lot of them

examples:
istanbul ignore next: dev
prettier-ignore
@neogeek
Copy link
Member

neogeek commented Jul 12, 2017

Currently doxdox ignores document blocks via this syntax https://github.com/tj/dox#ignore. Would it help to also add support for the @ignore tag?

Also are these // single line comment or /* single star comment */?

@aretecode
Copy link
Author

aretecode commented Jul 12, 2017 •
edited

@neogeek the latter /* istanbul-ignore next */ /* prettier ignore */

@neogeek
Copy link
Member

neogeek commented Jul 12, 2017

Cool. I'll take a look at this as soon as I can. Thanks!

@neogeek neogeek mentioned this issue Jul 14, 2017
Merged
@neogeek
Copy link
Member

neogeek commented Aug 24, 2017

Released a fix for this with the latest version of https://github.com/neogeek/doxdox-parser-dox/releases/tag/v1.1.3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@neogeek @aretecode