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.

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

Ignore tags by config #500

Closed
otakustay opened this issue Nov 23, 2013 · 2 comments
Closed

Ignore tags by config #500

otakustay opened this issue Nov 23, 2013 · 2 comments

Comments

@otakustay
Copy link

Some project use the old jsdoc or closure compiler style tags, so there are some tags jsduck cannot recognize and would output some warnings when generating docs.

Implementing a custom tag is a solution, but what we need is to just elliminate these warnings, not make sense of all these tags, a custome tag introduces ruby programming and extra .rb files

So it would be nice if we can specify some tags to be ignored in config file or command line arguments, such as:

jsduck --ignore-tags="@file, @overview, @inner"
@nene
Copy link
Member

nene commented Nov 23, 2013

If you just want to disable the warnings, use the --warnings option to disable all warnings for unknown tags and scope it to the external library:

--warnings=-tag:path/to/external/lib

Possibly this warning type could be improved to allow disabling warnings for certain tags like so:

--warnings=-tag(file,overview,inner)

But for external libraries it's more likely you'd like to disable all warnings altogether:

--warnings=-all:path/to/external/lib

@otakustay
Copy link
Author

Disable all warning about unknown tags is a solution, but far from good. The warning is really useful to find out typos in doc comments, such as typing @param to @prarm or whatever, so it would still be nice if jsduck could disable warnings for specific tags by config.

The second improvement perfectly solve our problem:

--warnings=-tag(file,overview,inner)

@nene nene closed this as completed in d226545 Nov 26, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants