You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I have some modules (AMD) with "." in their name (like "core.lang.js" in the example below).
I can see two options: put module name in quotes and do not do this.
If I skip quotes in @export (in core.lang.js) and in @type (in core.js) (see #1 in the code) then generated doc will contain:
Index: lang in Module, link leads to lang.html (ok)
module-core.html: lang :module:core.lang where link module:core.lang leads to module-core.html#lang (wrong!)
If I put quotes (see #2 in the code) then generated doc will contain:
Index: "core.lang" in Module (with quotes!) leads to _.html (wrong!)
module-core.html: lang :module:"core.lang" where link module:"core.lang" leads to _.html (wrong!)
.html is actually page for core.lang module, but obviously it should not be named ".html"
So none of cases (with and without quotes) works correctly.
core.lang.js:
define([],function(){/** * #1: @exports core.lang * #2: @exports "core.lang" */varlang={/** * Defines a class * @returns {Function} */Class: function(){}};returnlang;});
core.js:
define(["core.lang"],function(lang){/** * @exports core */varcore={};/** * base language helpers * #1: @type module:core.lang * #2: @type module:"core.lang" */core.lang=lang;returncore;});
The text was updated successfully, but these errors were encountered:
hegemonic
changed the title
Issues with documenting AMD modules containing "." in their names
Strip quotes from quoted module names, like module:"core.lang"
Dec 8, 2015
I have some modules (AMD) with "." in their name (like "core.lang.js" in the example below).
I can see two options: put module name in quotes and do not do this.
If I skip quotes in
@export
(in core.lang.js) and in@type
(in core.js) (see#1
in the code) then generated doc will contain:lang :module:core.lang
where linkmodule:core.lang
leads to module-core.html#lang (wrong!)If I put quotes (see
#2
in the code) then generated doc will contain:lang :module:"core.lang"
where linkmodule:"core.lang"
leads to _.html (wrong!)So none of cases (with and without quotes) works correctly.
core.lang.js:
core.js:
The text was updated successfully, but these errors were encountered: