DocComment Fields |
The DocComment type exposes the following members.
Name | Description | |
---|---|---|
![]() | _annotationFlags | (Inherited from Annotation.) |
![]() | _annotations |
Any Annotations (Comments, DocComments, Attributes,
or Messages) associated with the CodeObject (null if none).
(Inherited from CodeObject.) |
![]() | _columnNumber |
The starting column number associated with the CodeObject if parsed from or written to text form.
(Inherited from CodeObject.) |
![]() | _content |
The content can be a simple string or a ChildList of DocComment objects, or in some cases it can
also be a sub-tree of embedded code objects.
|
![]() | _formatFlags |
Formatting flags - for line feeds, braces, etc.
(Inherited from CodeObject.) |
![]() | _lineNumber |
The starting line number associated with the CodeObject if parsed from or written to text form.
(Inherited from CodeObject.) |
![]() | _parent |
The parent CodeObject.
(Inherited from CodeObject.) |
![]() | _prefixSpaceCount | (Inherited from CommentBase.) |
![]() ![]() | ParseToken |
The token used to parse the code object.
|
![]() ![]() | ParseTokenAssignAttrValue |
The token used to assign values to attributes in document comments.
|
![]() ![]() | ParseTokenBlock |
The start token for block-style document comments.
|
![]() ![]() | ParseTokenEndTag |
The token that indicates the end of a documentation comment XML tag.
|
![]() ![]() | ParseTokenTagClose |
The end token for documentation comment XML tags.
|
![]() ![]() | ParseTokenTagOpen |
The start token for documentation comment XML tags.
|
![]() ![]() | ParseTokenValueQuote1 |
A token used to quote data in document comments.
|
![]() ![]() | ParseTokenValueQuote2 |
A token used to quote data in document comments.
|
![]() ![]() | Validate |
Determines if DocComments are validated for valid and matching tags, and if warnings are logged for unmatched DocParamRef tags.
|