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 241366 - Documentation of params in jsdoc header not recognized
Summary: Documentation of params in jsdoc header not recognized
Status: RESOLVED WORKSFORME
Alias: None
Product: javascript
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 7.4
Hardware: PC Windows 7
: P3 normal (vote)
Assignee: Martin Fousek
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-02-04 08:23 UTC by RichardPilks
Modified: 2014-02-05 05:19 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 RichardPilks 2014-02-04 08:23:46 UTC 
When attempting to document a javascript function contained in script tags in a phtml view file (Zend framework 1.12), a hint incessantly maintains that I have not documented the parameters.  I have tried to do so as shown in the code snippet:

    /**
     * Function to look-up name associated with code.
     * The action will respond with the name / description or "-Unknown?-"
     *
     * @param {string} inputId	Input ID = [type]_id to determine type of code
     * @param {string} thisVal	Current value in input to lookup with
     * @returns {Boolean}	True if known
     */
    function getName(inputId, thisVal)
    {
       // do stuff
    }

If have tried @params instead of @param, remains same.

What have I done wrong? Or is there a bug causing this.
Comment 1 Vladimir Riha 2014-02-04 08:34:13 UTC 
Reproducible in 7.4, but seems to work fine in Dev build. Could you please give it a try in Dev build from [1] to see if it helps? Thank you


[1] http://bits.netbeans.org/netbeans/trunk/nightly/latest/


Product Version: NetBeans IDE Dev (Build 201401310001)
Java: 1.8.0-ea; Java HotSpot(TM) Client VM 25.0-b66
Runtime: Java(TM) SE Runtime Environment 1.8.0-ea-b125
System: Linux version 3.2.0-48-generic-pae running on i386; UTF-8; en_US (nb)
Comment 2 RichardPilks 2014-02-04 08:46:35 UTC 
I will have to download and try the dev build tonight on a different PC.  Current machine is for production development.

Thanks for confirming it (in 7.4)
Comment 3 RichardPilks 2014-02-04 20:57:35 UTC 
I downloaded the nightly Dev build (Build 201402040001) and retested the file.

It appears to be OK in that build.  I will live with the problem until the next release version.

Thanks to Vladimir Riha for confirming bug and pointing out the dev version having fixed it.

Richard
Comment 4 Martin Fousek 2014-02-05 05:19:43 UTC 
(In reply to RichardPilks from comment #3)
> It appears to be OK in that build.  I will live with the problem until the
> next release version.

Thanks for trying that out in the latest build.

> Thanks to Vladimir Riha for confirming bug and pointing out the dev version
> having fixed it.

Sorry for your issue within the 7.4. I'm closing this as worksforme since the trunk's build is already OK.