Double-quotes in names should be stripped in the output (was Dots in folder names causes problem with module names)

[tstatler]

A custom of a framework I'm documenting involves using dots (.) in folder names, like a "folder extension" so to speak. For instance:

lib/folder.fun

The folder named "folder.fun" contains the JavaScript file that exports the symbol (Funclass, in this case)

lib/folder.fun/funclass.js

I tagged the class like this:

@Class module:lib/folder.fun.Funclass

Thhe full module name is not picked up by the parser (I'm assuming) due to the dot in the folder name. The actual output names the module "fun" instead of the desired "lib/folder.fun".

[micmath]

Support for names with special-meaning characters, like dot, hash, etc, is new in JSDoc 3, so it is not well field-tested. But you can certainly give it a try:

/**
 * @module "lib/folder.fun"
 */

/**
 * @class module:"lib/folder.fun".Funclass
 */

[tstatler]

Brilliant! The only change I would request is that the double-quotes are stripped in the output, but that's probably something I can fix in the template?

Thanks!

[micmath]

Closing this as the original issue raised by the poster is already addressed. Removing quotes in the template is a separate issue that can be raised in a separate issue if needed.