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

Summary: Try to detect wrong form of documentation
Product: javascript Reporter: Petr Pisl <ppisl>
Component: DocumentationAssignee: Petr Pisl <ppisl>
Status: NEW ---    
Severity: normal    
Priority: P3    
Version: 7.3   
Hardware: PC   
OS: Linux   
Issue Type: ENHANCEMENT Exception Reporter:

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.