Skip to content
New issue

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

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

Already on GitHub? # to your account

Document additional Closure Compiler tags #171

Open
23 tasks
hegemonic opened this issue Jul 16, 2017 · 1 comment
Open
23 tasks

Document additional Closure Compiler tags #171

hegemonic opened this issue Jul 16, 2017 · 1 comment
Milestone

Comments

@hegemonic
Copy link
Contributor

hegemonic commented Jul 16, 2017

We're adding support for a bunch of Closure Compiler tags in JSDoc 3.6.0. This issue lists the tags that need to be documented. All of these are Closure Compiler-only unless otherwise noted.

  • @define
  • @dict (no-op)
  • @export (no-op)
  • @externs (no-op)
  • @fileoverview (already documented as a synonym for @file)
  • @final (supported since 3.3.0 as a Closure Compiler-only synonym for @readonly)
  • @implicitCast (no-op)
  • @modifies (JSDoc and Closure Compiler)
  • @noalias (no-op)
  • @nocollapse (no-op)
  • @nocompile (no-op)
  • @nosideeffects
  • @polymer (no-op)
  • @polymerBehavior (no-op)
  • @preserve (synonym for @license)
  • @public (document that it allows a type for Closure Compiler)
  • @record (treated as a synonym for @interface)
  • @struct (no-op)
  • @suppress (no-op)
  • @template (no-op)
  • @this (different semantics than JSDoc)
  • @typedef (different semantics than JSDoc)
  • @unrestricted (no-op)
@hegemonic hegemonic added this to the 3.6.0 milestone Jul 16, 2017
@hegemonic
Copy link
Contributor Author

On second thought, I don't really want to add new pages for all of these tags, given that:

  • JSDoc just ignores most of them
  • Most JSDoc users won't care about these tags

Maybe we should just do this:

  • Add a new page about JSDoc's support for Closure Compiler annotations
  • Add or update the tag pages for tags that actually do something

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

1 participant