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 244463 - documentation parser requires "{}" in parameter type
Summary: documentation parser requires "{}" in parameter type
Status: VERIFIED INVALID
Alias: None
Product: javascript
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 8.0
Hardware: PC Windows 7
: P4 normal (vote)
Assignee: Martin Fousek
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-05-13 12:25 UTC by Enric_Naval
Modified: 2014-05-23 06:08 UTC (History)
2 users (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Enric_Naval 2014-05-13 12:25:53 UTC
Netbeans expects to see

* @param {boolean}  b_Filtered stuff

but only in PHP! And PHPDocumentor doesn't require the "{}".


In a .js file, this docblock gives warning "Undocumented parameters: b_Filtered, a_ids":

/**
 * stuff
 *
 * @param boolean b_Filtered stuff
 * @param array   a_ids  stuff
 *
 * @author xxxxx
 * @date 2013-05-06
 */
function do_something(b_Filtered, a_ids) {
  //....
  temp1 = b_Filtered;
  temp2 = a_ids;
}



The same format in PHP gives no warnings:

/**
 * stuff
 *
 * @param boolean $b_Filtered stuff
 * @param array   $a_ids  stuff
 *
 * @author xxxxx
 * @date 2013-05-06
 */
function do_something($b_Filtered, $a_ids) {
  //....
    $temp1 = $b_Filtered;
    $temp2 = $a_ids;
}
Comment 1 Vladimir Riha 2014-05-13 12:47:16 UTC
You cannot compare documentation for PHP and JavaScript. JavaScript documentation is based on JSDoc where {} is required, see [1]

[1] http://usejsdoc.org/tags-param.html
Comment 2 Martin Fousek 2014-05-23 06:08:28 UTC
Yeah, you have to use JSDoc, SDoc or ExtDoc syntax. BTW, the JSDoc has the best support on our side. If you would use different syntax such sources would be unreadable for another IDEs, developers etc.