DocSummary Properties

This property is just to make debugging easier.

Annotation formatting flags.

Annotations (comments, attributes, directives, messages) associated with the current code object.

The column number associated with the CodeObject (if any, 0 if none).

The comment for the code object (if any).

The content of the documentation comment - can be a simple string, a ChildList of DocComment objects, or a sub-tree of embedded code objects.

The documentation comment for the code object (if any).

The End-Of-Line comment for the code object (if any).

True if the code object has any annotations.

True if the code object has any attributes.

True if the code object has any comments of any kind.

True if the code object has any compiler directive annotations.

True if the code object has any documentation comments.

True if the code object has any EOL comments.

True if the code object has any EOL or Postfix annotations.

True if the code object has any error messages.

True if the code object has any annotations on separate lines.

True if the code object has any Infix comments.

True if the code object has any generated messages.

Determines if the code object has no indentation.

True if the code object has any regular (non-doc) preceding (non-EOL, non-Infix, non-Postfix) comments.

True if the code object has any postfix annotations.

Determines if the code object has a terminator character.

Any hidden reference to another CodeObject.

The infix comment for the code object (if any).

True if the annotation appears at the end-of-line (should only be true for EOL comments).

Determines if the code object appears as the first item on a line.

True if the code object defaults to starting on a new line.

Determines if the code object is generated.

Determines if the 'grouping' (has parens or braces) status has been set.

True if this annotation is marked as any type of Infix location.

True if this annotation is marked as Infix location #1.

True if this annotation is marked as Infix location #1.

True if this annotation is marked as Infix location #1.

True if the annotation should be listed at the CodeUnit and Solution levels (for display in an output window).

Determines if the newline count has been set on the code object.

True if this annotation appears after the object it's attached to as opposed to before it.

True if the CodeObject is renderable.

Determines if the code object only requires a single line for display.

True if the code object only requires a single line for display by default.

The line number associated with the CodeObject (if any, 0 if none).

True if the documentation comment is missing an end tag.

True if the documentation comment is missing a start tag.

The number of newlines preceding the object (0 to N).

The parent CodeObject.

The postfix comment for the code object (if any).

The count of prefix spaces (if any) before the comment delimiter.

The XML tag name for the documentation comment.

Get the annotation in text format.