Just thought I'd expand on this as it is a bit misleading and my
initial post was probably a bit abrupt.
@public and tags such as this are defined as being "discouraged" in
the Google style guide, which is fine.
I'm just having a bit of trouble making the distinction between
"discouraged" and actually breaking the style rules (as the Linter's
error logs would suggest). I understand that using @public would cause
an error in the Google Linter because you wouldn't expect to see
Google code with these tags in them.
However other applications may use these tags, which is fine (they're
JsDoc after all!), but the Linter would throw an error.
I think it might be a nice feature to include Google's set of approved
tags under the 'strict' flag, and let the full range of JsDoc tags be
allowed when strict is not set. This way those who use the Linter and
also use the full range of JsDoc annotations reap the benefits whereas
Google's internal code (which I am sure uses the strict flag)
maintains the restricted set of tags.
On Sep 2, 1:36 pm, Steven Hall <stvh...@gmail.com
> After getting back some errors telling me that @public was not a valid
> JsDoc annotation, I did some investigating into the causes.
> I found that the STANDARD_DOC set in statetracker.py seemed to only
> contain the JsDoc annotations defined in the Google Style Guide.
> This is fine and I'd imagine it to be so, as this is a Closure tool.
> However, it's clearly stated in the style guide that
> "We [Google] use JSDoc comments to document files, classes,
> methods and properties."
> It's a bit misleading that, despite Google supporting JsDoc, they only
> use a subset of the tags. Similarly, the @protected tag doesn't seem
> to exist in the JsDoc documentation (found herehttp://code.google.com/p/jsdoc-toolkit/wiki/TagReference