wenchun / jsdoc-toolkit

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

name contains special chars like "#", "-" and "." #89

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
What steps will reproduce the problem? What is the expected output? What do
you see instead?

I got some methods with names including chars used by namepath,
such as a lisp-cased method "for-each(func, arr)", or a sub-method like
"build.install(obj)" (I take it as a curried version of method "build"),
but they are only named "each", "sequence" in doc.

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

jsdoc_toolkit 2.0 beta, winxp sp2

Please provide any additional information below.

Will it be a good point to support special names?
For example, surround the name with "" to ignore special chars:

pack.build = function (task) { ... };

/** @name "build.install" */
pack.build.install = function () { build("install"); }

Original issue reported on code.google.com by xngzhao...@gmail.com on 7 Mar 2008 at 6:29

GoogleCodeExporter commented 8 years ago
There is likely a bug at work here. The following *should* produce a symbol 
named
"pack.build.install", member of "pack". Instead it produces 
"pack.pack.build.install".

/** @namespace */
pack = {}

pack.build = function(task) {};

/** @memberOf pack */
pack.build.install = function() {}

Original comment by micmath on 8 Mar 2008 at 10:56

GoogleCodeExporter commented 8 years ago
Dotted names, used with @memberOf, like in your example of "build.install" 
marked as
a member of "pack" is now supported in revision 528. This will be in the next
official release.

Using names with hash or dash are not supported yet, but if it is required 
please
file as a separate issue, as I think it has different requirements than dotted 
names.

Original comment by micmath on 9 Mar 2008 at 1:52