/wiki/TagConstructs.wiki
http://jsdoc-toolkit.googlecode.com/ · Unknown · 34 lines · 27 code · 7 blank · 0 comment · 0 complexity · b3076491c6e04e2098abaade4032cca4 MD5 · raw file
- #summary @constructs
- == The @constructs Tag ==
- When using the `@lends` tag, the `@constructs` tag allows you to document that a particular function will be used to construct instances of the class.
- === Syntax ===
- {{{
- @constructs
- }}}
-
- === Example ===
- {{{
- var Person = makeClass(
- /**
- @lends Person.prototype
- */
- {
- /** @constructs */
- initialize: function(name) {
- this.name = name;
- },
- say: function(message) {
- return this.name + " says: " + message;
- }
- }
- );
- }}}
- Note: that when using this tag you should not also use the `@constructor` or `@class` to document the class in another doclet, all documentation for the class should go in the `@constructs` doc comment instead.
- == See Also ==
- * The [TagLends @lends] tag.