This topic illustrates the information that is provided to each documentation tag.
@class classname [documentation_group]
The @class tag must be given a class name. The name that is used to bind the constructor, member functions, and properties back to the class.
The optional documentation_group is one word used to group sets of classes, functions, and variables so they can be included or excluded from the generated documentation as a group. See Generating Documentation.
@param param_name type_name [description]
The @param tag must be given the name of the parameter, and its expected type (such as number, section, object, shape, and so on). As JavaScript is type-less the parameter type can only be a suggestion but it enables callers to see what types of values are expected by the function.
The optional description may be given on multiple lines, but cannot contain blank lines.
@type type_name [description]
The @type tag must be given the type of the variable or the return type of the function being documented (such as number, section, object, or shape).
If documenting a function the optional description is given next to the return type of the function, so the caller can see how to interpret the return value.
@scope namespace [group]
The @scope tag may be given a namespace of Document, Section, Control, or the name of a class defined with an @class tag.
The optional group is one word used to group sets of classes, functions, and variables so they can be included or excluded from the generated documentation as a group. See Generating Documentation.