wenchun / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

Documentation: Version 2 Tag Reference (several tags missing) #136

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
Three tags, currently listed for JsDoc Toolkit, are missing from the Version 2 
list. The missing tags 
are:

exception
inherits
return

Current list (last update 11/14/2007):
http://code.google.com/p/jsdoc-toolkit/wiki/TagReference

Version 2 list (last update 4.10.2008 02:11):
http://www.jsdoctoolkit.org/wiki/?page=Tag%20Reference

Original issue reported on code.google.com by jeremy.f...@comcast.net on 7 May 2008 at 11:23

GoogleCodeExporter commented 8 years ago
I've updated the documentation to hopefully provide better information about the
changes from version 1 to 2. You were very helpful by reporting this, I've been
meaning to do an audit of tag changes and you've saved me some work I was 
effectively
avoiding.

@exception - now a deprecated synonym for @throws
@inherits - now a deprecated synonym for @borrows tag, with new syntax.
@return - now a deprecated synonym for @returns

I've tried to make tags more uniform by expressing them as present-tense verbs 
where
possible. @exception and @return have always been synonyms, but @inherits is 
the only
really non-compatible change from 1 to 2 because it requires a new syntax, but 
the
old syntax was essentially broken anyway so I might class that as a bug fix.

Thanks for reporting this. Please report any other problems you find with the 
docs in
future.

Original comment by micmath on 8 May 2008 at 7:16