diff --git a/docs/tags/module.md b/docs/tags/module.md index 75a75e3c..4d4e0ba0 100644 --- a/docs/tags/module.md +++ b/docs/tags/module.md @@ -32,5 +32,32 @@ Creates docs for: * module:webui/utils.twiddle +If the module Identifier contain [unsafe characters](../unsafe-characters.md) you must quote the name in any [doc refernces](../doc-references.md) to that module. + + /** @module ./utils.strings */ + define('./utils.strings', + function() { + return { }; + } + ); + + /** + * @module url/parser + * @requires module:"./utils.strings" + */ + define('./utils.strings', + ['./utils.strings'], + function(strings) { + return { }; + } + ); + +Notice that in the example above the module identified as "./utils.strings" has dot characters in its name. So the name must be quoted in the subsequent `@requires` tag. + +See +--- +* [@requires](requires.md) +* [Documenting CommonJS Modules](../commonjs.md) + +[1]: http://wiki.commonjs.org/wiki/Modules/1.1.1#Module_Identifiers -[1]: http://wiki.commonjs.org/wiki/Modules/1.1.1#Module_Identifiers \ No newline at end of file