Added more docs for tagging commonjs modules.

This commit is contained in:
Michael Mathews 2010-12-18 22:18:59 +00:00
parent 5a78b4ada1
commit bc6f1a9fa3

View File

@ -32,5 +32,32 @@ Creates docs for:
* module:webui/utils.twiddle * 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