Tag

Represents a tag in a comment

Data differs by types.

types, name, description for @param
types, description for @return
local or title & url for @see
visibility for @api
types for @type
parent for @memberOf
otherClass for @augments
otherMemberName, thisMemberName for @borrows
string for other types

(defined in /src/types/tag.coffee:15)

class Tag

Constructor

Parameters

(None)

Tag::description : Stringproperty

Tag::name : Stringproperty

Tag::string : Stringproperty

The remain string if this tag is unknown

Tag::type : Stringproperty

The type of this tag

Tag::typeString : Stringproperty

If a typeString is added by plugins, it will be parsed to types.

Tag::types : Array<String>property

Fork me on GitHub