This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 217027 - jsdoc documentation mentions @returns but not @return
Summary: jsdoc documentation mentions @returns but not @return
Status: RESOLVED FIXED
Alias: None
Product: javascript
Classification: Unclassified
Component: Editor (show other bugs)
Version: 7.3
Hardware: PC Linux
: P3 normal (vote)
Assignee: Martin Fousek
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-08-17 12:25 UTC by fordfrog
Modified: 2012-09-05 02:06 UTC (History)
0 users

See Also:
Issue Type: DEFECT
Exception Reporter:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description fordfrog 2012-08-17 12:25:57 UTC 
currently js editor generates this for return statement in comments:

@return undefined

but jsdoc documentation mentions this syntax:

@returns {returnType} returnDescription

here is the link:
http://code.google.com/p/jsdoc-toolkit/wiki/TagReturns
Comment 1 Martin Fousek 2012-09-04 12:41:25 UTC 
That's right. Problem is that "returns" is ideal entry but in many sources, docs are "return" used. But you are right that the JsDoc valid entry should be generated. Thanks for entering that ...
Comment 2 Martin Fousek 2012-09-04 12:46:44 UTC 
Fixed in web-main #f6fa9a334f0f.

Thanks again for reporting.
Comment 3 Quality Engineering 2012-09-05 02:06:35 UTC 
Integrated into 'main-golden', will be available in build *201209050001* on http://bits.netbeans.org/dev/nightly/ (upload may still be in progress)
Changeset: http://hg.netbeans.org/main-golden/rev/f6fa9a334f0f
User: Martin Fousek <marfous@netbeans.org>
Log: #217027 - jsdoc documentation mentions @returns but not @return