PageRenderTime 13ms CodeModel.GetById 8ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/wiki/TagExports.wiki

http://jsdoc-toolkit.googlecode.com/
Unknown | 35 lines | 25 code | 10 blank | 0 comment | 0 complexity | 019db522f986c76fb2e2eb9173f5fc24 MD5 | raw file
 1#summary @exports
 2
 3== The @exports Tag (available since 2.2.0) ==
 4
 5The `@exports` tag allows you to document any symbol as if it were a different symbol with a different name. This might be useful if you were using an alias to another symbol in your code but wanted to document that alias under the original name.
 6
 7=== Syntax ===
 8
 9{{{
10@exports codedName as documentedName
11}}}
12
13  * codedName - Required: the name you are using in your code.
14  * documentedName - Required: the name you want to appear in the documentation.
15
16=== Example ===
17
18{{{
19/** @namespace */
20var mxn = {};
21
22(function() { 
23    /** @exports Map as mxn.Map */
24    var Map =
25        /** @constructor */
26        mxn.Map = function() {
27        };
28    
29    /** This will be documented as a method of mxn.Map. */
30    Map.prototype.doThings = function() {
31    };
32})();
33}}}
34
35Multiple exports tags are allowed in one documentation comment. It is a good idea, but not required, to put the documentation comment adjacent to the code where the alias is created.