new Tag(tagTitle, tagBodyopt, metaopt)
Constructs a new tag object. Calls the tag validator.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
tagTitle |
string | ||
tagBody |
string |
<optional> |
|
meta |
object |
<optional> |
Members
originalTitle
text
The text following the tag (for example, `text` in `@title text`).
Whitespace is trimmed from the tag text as follows:
+ If the tag's `keepsWhitespace` option is falsy, all leading and trailing whitespace are
removed.
+ If the tag's `keepsWhitespace` option is set to `true`, leading and trailing whitespace are
not trimmed, unless the `removesIndent` option is also enabled.
+ If the tag's `removesIndent` option is set to `true`, any indentation that is shared by
every line in the string is removed. This option is ignored unless `keepsWhitespace` is set
to `true`.
**Note**: If the tag text is the name of a symbol, and the symbol's name includes leading or
trailing whitespace (for example, the property names in `{ ' ': true, ' foo ': false }`),
the tag text is not trimmed. Instead, the tag text is wrapped in double quotes to prevent the
whitespace from being trimmed.
title
The title of the tag (for example, `title` in `@title text`).