new Tag(members, count, required)
Parameters:
Name | Type | Description |
---|---|---|
members |
string | The tag contents to parse |
count |
number | The position of the tag in the usage string |
required |
boolean | The type of tag (required or optional) |
- Since:
-
- 0.2.1
- Source:
- lib/usage/Tag.js#L14
Properties
-
possibles :Array.<Possible>
-
The possibilities of this tag
Type:
- Array.<Possible>
- Since:
-
- 0.2.1
- Source:
- lib/usage/Tag.js#L27
-
type :string
-
The type of this tag
Type:
- string
- Since:
-
- 0.2.1
- Source:
- lib/usage/Tag.js#L20
Methods
-
<static> parseMembers(members, count)
-
Parses members into usable possibles
Parameters:
Name Type Description members
string The tag contents to parse count
number The position of the tag in the usage string - Since:
-
- 0.2.1
- Source:
- lib/usage/Tag.js#L37
Returns:
- Type
- Array.<Possible>
-
<static> parseTrueMembers(members)
-
Parses raw members true members
Parameters:
Name Type Description members
string The tag contents to parse - Since:
-
- 0.2.1
- Source:
- lib/usage/Tag.js#L68
Returns:
- Type
- Array.<string>