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

Add support for file / overview / fileoverview tag in closurecompiler #83

Closed
necolas opened this issue Jan 25, 2015 · 5 comments
Closed
Labels

Comments

@necolas
Copy link

necolas commented Jan 25, 2015

As defined in JSDoc:

http://usejsdoc.org/tags-file.html

@qfox qfox changed the title Add support for file / overview / fileoverview tag Add support for file / overview / fileoverview tag in closurecompiler Jan 25, 2015
@qfox
Copy link
Member

qfox commented Jan 25, 2015

@necolas Thanks for filing it.

For now closurecompiler set is merge of https://developers.google.com/closure/compiler/docs/js-for-compiler#tags and
https://code.google.com/p/jsdoc-toolkit/wiki/TagReference

On the second page we have @fileOverview tag — that's what you need I think.
And it's in set https://github.com/jscs-dev/jscs-jsdoc/blob/master/lib/tags/closurecompiler.json#L22 — Not the case for jsdoc-toolkit and jsdoc3 are different (jsdoc3 tag set).

I'm still not sure for now that we should add aliases for @fileOverview there.

@necolas
Copy link
Author

necolas commented Jan 25, 2015

OK, we'll switch to @fileOverview assuming closurecompiler is cool with it. Thanks

@qfox
Copy link
Member

qfox commented Jan 25, 2015

If you using some tool to autogen docs with cc — please try to use other aliases there. It would be very helpful.

@qfox
Copy link
Member

qfox commented Jan 25, 2015

@necolas I feel like a bad guy who forced you to use old tag. According to https://code.google.com/p/jsdoc-toolkit/: "...project is no longer..." and it redirects to github account of jsdoc3. So you're right, and I'm wrong. Sorry for that.

Also I'm thinking that better to have sets for different docgen tools like jsdoc3, doxx or yuidoc (if somebody need it). Separated closurecompiler set probably is a good thing, but better to have it inside jsdoc3 (at least extend cc set with jsdoc3).

Am I right?

@qfox qfox added the tag sets label Jan 25, 2015
@necolas
Copy link
Author

necolas commented Jan 26, 2015

I don't know about how much closurecompiler and jsdoc3 are related these days, but your plan sounds good to me. Hard to find a list of all the supported closurecompiler tags. For example, various google projects have @suppress and @preserveTry, but they aren't documented in the contemporary closure docs. Easy to add to the extra though.

Thanks for your help with this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants