mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
Moving docs to gh-pages branch.
This commit is contained in:
parent
210a7d103c
commit
afe2b90e1f
@ -1,5 +0,0 @@
|
||||
Index of Tags Supported by JSDoc 3
|
||||
==================================
|
||||
|
||||
* [@description](tags/description.md) - also: @desc
|
||||
* [@module](tags/module.md)
|
||||
@ -1,63 +0,0 @@
|
||||
The @module Tag
|
||||
===============
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Used to document a CommonJS module.
|
||||
|
||||
Syntax
|
||||
------
|
||||
|
||||
@module moduleId
|
||||
|
||||
* moduleId (required) - The [CommonJs module identifer][1] for this module.
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
/**
|
||||
* @module webui/utils
|
||||
*/
|
||||
|
||||
/**
|
||||
* @method
|
||||
*/
|
||||
exports.twiddle = function() {
|
||||
}
|
||||
|
||||
Creates docs for:
|
||||
|
||||
* module:webui/utils
|
||||
* 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
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user