How can namespaces be documented in JavaScript with jsDoc?
Here is my attempt, is this right?
/**
* My special namespace
*
* @name my.namespace
* @namespace
*/
$namespace('my.namespace', /** @lends my.namespace **/ {
/**
* Foo - does something really neat...
* @function
*/
foo: function() {
}
});
Just to clarify, the above is used as follows:
my.namespace.foo();
How can namespaces be documented in JavaScript with jsDoc?
Here is my attempt, is this right?
/**
* My special namespace
*
* @name my.namespace
* @namespace
*/
$namespace('my.namespace', /** @lends my.namespace **/ {
/**
* Foo - does something really neat...
* @function
*/
foo: function() {
}
});
Just to clarify, the above is used as follows:
my.namespace.foo();
Share
Improve this question
asked Aug 26, 2011 at 15:31
Lea HayesLea Hayes
64.2k16 gold badges69 silver badges118 bronze badges
1
-
I know this is really old, but i am curious. Is
$namespace
something custom of yours? – j_walker_dev Commented Jan 5, 2015 at 10:17
1 Answer
Reset to default 8This feature is available in jsdoc3 micmath/jsdoc. The syntax of jsdoc3 is different to jsdoc-toolkit (jsdoc2)
The following example was by Michael jsdoc and pseudo-namespaces?
/**
* Document me.
* @namespace my
*/
/**
* My special namespace
* @namespace my.namespace
*/
$namespace('my.namespace', /** @lends my.namespace **/ {
/**
* Foo - does something really neat...
*/
foo: function() {
}
});