yeomann / jsdoc-toolkit

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

Override of _global_ namespace fails to produce expected results #294

Open GoogleCodeExporter opened 8 years ago

GoogleCodeExporter commented 8 years ago
/**
* @namespace
* @name _global_
* @description When coded properly there should be no members shown here.
*/

What steps will reproduce the problem?
1. add the above after @fileOverview Block to file
2. run jsrun.jar on file
3. view documentation

What is the expected output? What do you see instead?
Expected: description added to _global_ name space;
Result seen: 2 instances of _global_ listed under classes without @description.

What version of the product are you using? On what operating system?
v2.3.2
XP SP3 Pro
Java 1.6.0_20

Please provide any additional information below.
able to answer questions as needed.

Original issue reported on code.google.com by abyss...@gmail.com on 3 Jul 2010 at 3:54

GoogleCodeExporter commented 8 years ago
"_global_" ia a reserved name in JSDoc 2, you cannot modify it by adding 
descriptions or other attributes. The desired behaviour here would be to warn 
that it is a reserved name and then ignore the doclet.

Original comment by micmath on 3 Jul 2010 at 4:08

GoogleCodeExporter commented 8 years ago
Yes, a warning would then be most fitting for this issue.

Original comment by abyss...@gmail.com on 3 Jul 2010 at 5:42

GoogleCodeExporter commented 8 years ago
Hello! how to delete _global_ namespace?

Original comment by danielarkai@gmail.com on 20 Dec 2011 at 6:09