search

mryozo16 / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

Inconsistent alias delimiter #145

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago 
What steps will reproduce the problem?
/**
 * @class
 * @name Shape
 * @since version 1
 * @property {Number} id ID of the shape
 */

/**
 * @name name
 * @since version 2
 * @memberOf Shape
 * @type String
 * @description Name of the shape
 */

What is the expected output? What do you see instead?
The property "id" is documented having an alias of Shape#id while the 
property "name" is documented as a static property (why?) having an alias 
of Shape.name (notice the dot)

What version of the product are you using? On what operating system?
2.0 XP SP2

Please provide any additional information below.

Original issue reported on code.google.com by herz...@gmail.com on 29 May 2008 at 1:27

GoogleCodeExporter commented 8 years ago 
Properties added via the @property tag are always assumed to be added as 
"instance
properties," that is: parent#property

In the second case you've explicitly said "name" is a property of the "Shape"
*class*, in other words a static property: parent.property

If you mean that "name" should be a member of instances of Shape, then use this:

@memberOf Shape#

See this for more info on the different delimiters used by JsDoc Toolkit:
http://www.jsdoctoolkit.org/wiki/?page=namepath

Original comment by micmath on 29 May 2008 at 1:53