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 257553 - Parameter properties are recognized as incorrect documentation
Summary: Parameter properties are recognized as incorrect documentation
Status: STARTED
Alias: None
Product: javascript
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 8.1
Hardware: PC Windows 10 x64
: P3 normal (vote)
Assignee: Petr Pisl
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2016-01-13 17:14 UTC by bennyn
Modified: 2016-07-27 08:43 UTC (History)
0 users

See Also:
Issue Type: DEFECT
Exception Reporter:

Attachments
Incorrect Documentation (100.18 KB, image/png)
2016-01-13 17:14 UTC, bennyn 		Details
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 bennyn 2016-01-13 17:14:55 UTC 
Created attachment 158119 [details]
Incorrect Documentation

I wanted to document my JavaScript code in NetBeans 8.1 and hoped it would accept JSDoc 3 syntax.

In JSDoc 3 there is support for parameter properties: http://usejsdoc.org/tags-param.html#parameters-with-properties

Unfortunately NetBeans shows a warning when defining parameter properties (see screenshot).
Comment 1 bennyn 2016-01-17 22:51:21 UTC 
As workaround I had to annotate my object "schema" the following way (which works in NetBeans 8.1):

@param {{version: number, objectStores: object, name: string}} schema Database configuration
Comment 2 Petr Pisl 2016-07-27 08:43:05 UTC 
This is not supported yet. I will look at this.