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 227147 - Try to detect wrong form of documentation
Summary: Try to detect wrong form of documentation
Status: NEW
Alias: None
Product: javascript
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 7.3
Hardware: PC Linux
: P3 normal (vote)
Assignee: Petr Pisl
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-03-07 09:46 UTC by Petr Pisl
Modified: 2014-10-06 13:06 UTC (History)
0 users

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Petr Pisl 2013-03-07 09:46:02 UTC
Have an example of function with JsDoc:

    /**
     * Adds an option to a select
     * @param object $sourceOption A jQuerified option object
     * @param string target Name of the target select: 'left' or 'right'
     * @param boolean ignoreIndex If true, the index will not be use to
     *                              determine the order of the options.
     **/
    function addSelectOption($sourceOption, target, ignoreIndex) {
    }

on the function declaration line is hint Undocumented Parameters ....., but the real problem is that the documentation has wrong form. The right form should be 

* @param {object} $sourceOption A jQuerified option object

There should be hint that will check it.