DocInclude Properties |
The DocInclude type exposes the following members.
Name | Description | |
---|---|---|
![]() | _AsString |
This property is just to make debugging easier.
(Inherited from CodeObject.) |
![]() | AnnotationFlags |
Annotation formatting flags.
(Inherited from Annotation.) |
![]() | Annotations |
Annotations (comments, attributes, directives, messages) associated with the current code object.
(Inherited from CodeObject.) |
![]() | ColumnNumber |
The column number associated with the CodeObject (if any, 0 if none).
(Inherited from CodeObject.) |
![]() | Comment |
The comment for the code object (if any).
(Inherited from CodeObject.) |
![]() | Content |
The content of the documentation comment - can be a simple string, a ChildList of DocComment objects, or
a sub-tree of embedded code objects.
(Inherited from DocComment.) |
![]() | DocComment |
The documentation comment for the code object (if any).
(Inherited from CodeObject.) |
![]() | EOLComment |
The End-Of-Line comment for the code object (if any).
(Inherited from CodeObject.) |
![]() | File | |
![]() | HasAnnotations |
True if the code object has any annotations.
(Inherited from CodeObject.) |
![]() | HasAttributes |
True if the code object has any attributes.
(Inherited from CodeObject.) |
![]() | HasComments |
True if the code object has any comments of any kind.
(Inherited from CodeObject.) |
![]() | HasCompilerDirectives |
True if the code object has any compiler directive annotations.
(Inherited from CodeObject.) |
![]() | HasDocComments |
True if the code object has any documentation comments.
(Inherited from CodeObject.) |
![]() | HasEOLComments |
True if the code object has any EOL comments.
(Inherited from CodeObject.) |
![]() | HasEOLOrPostAnnotations |
True if the code object has any EOL or Postfix annotations.
(Inherited from CodeObject.) |
![]() | HasErrors |
True if the code object has any error messages.
(Inherited from CodeObject.) |
![]() | HasFirstOnLineAnnotations |
True if the code object has any annotations on separate lines.
(Inherited from CodeObject.) |
![]() | HasInfixComments |
True if the code object has any Infix comments.
(Inherited from CodeObject.) |
![]() | HasMessages |
True if the code object has any generated messages.
(Inherited from CodeObject.) |
![]() | HasNoIndentation |
Determines if the code object has no indentation.
(Inherited from CodeObject.) |
![]() | HasNonEOLComments |
True if the code object has any regular (non-doc) preceding (non-EOL, non-Infix, non-Postfix) comments.
(Inherited from CodeObject.) |
![]() | HasPostAnnotations |
True if the code object has any postfix annotations.
(Inherited from CodeObject.) |
![]() | HasTerminator |
Determines if the code object has a terminator character.
(Inherited from CodeObject.) |
![]() | HiddenRef |
Any hidden reference to another CodeObject.
(Inherited from CodeObject.) |
![]() | InfixComment |
The infix comment for the code object (if any).
(Inherited from CodeObject.) |
![]() | IsEOL |
True if the annotation appears at the end-of-line (should only be true for EOL comments).
(Inherited from Annotation.) |
![]() | IsFirstOnLine |
Determines if the code object appears as the first item on a line.
(Inherited from CodeObject.) |
![]() | IsFirstOnLineDefault |
True if the code object defaults to starting on a new line.
(Inherited from CodeObject.) |
![]() | IsGenerated |
Determines if the code object is generated.
(Inherited from CodeObject.) |
![]() | IsGroupingSet |
Determines if the 'grouping' (has parens or braces) status has been set.
(Inherited from CodeObject.) |
![]() | IsInfix |
True if this annotation is marked as any type of Infix location.
(Inherited from Annotation.) |
![]() | IsInfixLocation1 |
True if this annotation is marked as Infix location #1.
(Inherited from Annotation.) |
![]() | IsInfixLocation2 |
True if this annotation is marked as Infix location #1.
(Inherited from Annotation.) |
![]() | IsInfixLocation3 |
True if this annotation is marked as Infix location #1.
(Inherited from Annotation.) |
![]() | IsListed |
True if the annotation should be listed at the CodeUnit and Solution levels (for display in an output window).
(Inherited from Annotation.) |
![]() | IsNewLinesSet |
Determines if the newline count has been set on the code object.
(Inherited from CodeObject.) |
![]() | IsPostfix |
True if this annotation appears after the object it's attached to as opposed to before it.
(Inherited from Annotation.) |
![]() | IsRenderable |
True if the CodeObject is renderable.
(Inherited from CodeObject.) |
![]() | IsSingleLine |
Determines if the code object only requires a single line for display.
(Inherited from DocComment.) |
![]() | IsSingleLineDefault |
True if the code object only requires a single line for display by default.
(Inherited from CodeObject.) |
![]() | LineNumber |
The line number associated with the CodeObject (if any, 0 if none).
(Inherited from CodeObject.) |
![]() | MissingEndTag |
True if the documentation comment is missing an end tag.
(Inherited from DocComment.) |
![]() | MissingStartTag |
True if the documentation comment is missing a start tag.
(Inherited from DocComment.) |
![]() | NewLines |
The number of newlines preceding the object (0 to N).
(Inherited from CodeObject.) |
![]() | Parent |
The parent CodeObject.
(Inherited from CodeObject.) |
![]() | Path | |
![]() | PostfixComment |
The postfix comment for the code object (if any).
(Inherited from CodeObject.) |
![]() | PrefixSpaceCount |
The count of prefix spaces (if any) before the comment delimiter.
(Inherited from CommentBase.) |
![]() | TagName |
The XML tag name for the documentation comment.
(Inherited from DocComment.) |
![]() | Text |
Get the annotation in text format.
(Inherited from Annotation.) |