Click or drag to resize

DocComment Fields

The DocComment type exposes the following members.

Fields
  NameDescription
Protected field_annotationFlags (Inherited from Annotation.)
Protected field_annotations
Any Annotations (Comments, DocComments, Attributes, or Messages) associated with the CodeObject (null if none).
(Inherited from CodeObject.)
Protected field_columnNumber
The starting column number associated with the CodeObject if parsed from or written to text form.
(Inherited from CodeObject.)
Protected field_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.
Protected field_formatFlags
Formatting flags - for line feeds, braces, etc.
(Inherited from CodeObject.)
Protected field_lineNumber
The starting line number associated with the CodeObject if parsed from or written to text form.
(Inherited from CodeObject.)
Protected field_parent
The parent CodeObject.
(Inherited from CodeObject.)
Protected field_prefixSpaceCount (Inherited from CommentBase.)
Public fieldStatic memberParseToken
The token used to parse the code object.
Public fieldStatic memberParseTokenAssignAttrValue
The token used to assign values to attributes in document comments.
Public fieldStatic memberParseTokenBlock
The start token for block-style document comments.
Public fieldStatic memberParseTokenEndTag
The token that indicates the end of a documentation comment XML tag.
Public fieldStatic memberParseTokenTagClose
The end token for documentation comment XML tags.
Public fieldStatic memberParseTokenTagOpen
The start token for documentation comment XML tags.
Public fieldStatic memberParseTokenValueQuote1
A token used to quote data in document comments.
Public fieldStatic memberParseTokenValueQuote2
A token used to quote data in document comments.
Public fieldStatic memberValidate
Determines if DocComments are validated for valid and matching tags, and if warnings are logged for unmatched DocParamRef tags.
Top
See Also