search

AaronNGray / jsdoc-toolkit

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

Add an @id (or @moduleId) tag #280

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
With CommonJS modules, module namespaces don't have a canonical name in the 
sense that it is 
assigned to a variable of that name, but rather have an "id" and they are 
retrieved using that id with 
the require() function. These ids are hierarchical paths - they contain the 
slash character.

Unfortunately, @name doesn't like slashes... it'll implicitly lead to 
FileNotFoundException in the 
generator as it'll append it to the symbols directory path :-(

I.e. this won't work:
@namespace
@name com/foo/bar/myModule

Any chance of either having @name support slashes, or alternatively, 
introducing a CommonJS-
specifc tag @id or better yet, @moduleId

Original issue reported on code.google.com by szege...@gmail.com on 26 Jan 2010 at 2:58

GoogleCodeExporter commented 9 years ago 
Custom tags are already supported in JsDoc Toolkit. Is that useful to you?

http://code.google.com/p/jsdoc-toolkit/wiki/FAQ#Using_custom_tags

Original comment by micmath on 14 Mar 2010 at 7:45

GoogleCodeExporter commented 9 years ago 
The @module tag will be supported natively in JSDoc 3.

Original comment by micmath on 27 Jun 2010 at 9:00

GoogleCodeExporter commented 9 years ago 
I'm closing this due to support coming in JSDoc 3.

Original comment by micmath on 3 Jul 2010 at 7:43