Click or drag to resize

DocReturns Properties

The DocReturns type exposes the following members.

Properties
  NameDescription
Public property_AsString
This property is just to make debugging easier.
(Inherited from CodeObject.)
Public propertyAnnotationFlags
Annotation formatting flags.
(Inherited from Annotation.)
Public propertyAnnotations
Annotations (comments, attributes, directives, messages) associated with the current code object.
(Inherited from CodeObject.)
Public propertyColumnNumber
The column number associated with the CodeObject (if any, 0 if none).
(Inherited from CodeObject.)
Public propertyComment
The comment for the code object (if any).
(Inherited from CodeObject.)
Public propertyContent
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.)
Public propertyDocComment
The documentation comment for the code object (if any).
(Inherited from CodeObject.)
Public propertyEOLComment
The End-Of-Line comment for the code object (if any).
(Inherited from CodeObject.)
Public propertyHasAnnotations
True if the code object has any annotations.
(Inherited from CodeObject.)
Public propertyHasAttributes
True if the code object has any attributes.
(Inherited from CodeObject.)
Public propertyHasComments
True if the code object has any comments of any kind.
(Inherited from CodeObject.)
Public propertyHasCompilerDirectives
True if the code object has any compiler directive annotations.
(Inherited from CodeObject.)
Public propertyHasDocComments
True if the code object has any documentation comments.
(Inherited from CodeObject.)
Public propertyHasEOLComments
True if the code object has any EOL comments.
(Inherited from CodeObject.)
Public propertyHasEOLOrPostAnnotations
True if the code object has any EOL or Postfix annotations.
(Inherited from CodeObject.)
Public propertyHasErrors
True if the code object has any error messages.
(Inherited from CodeObject.)
Public propertyHasFirstOnLineAnnotations
True if the code object has any annotations on separate lines.
(Inherited from CodeObject.)
Public propertyHasInfixComments
True if the code object has any Infix comments.
(Inherited from CodeObject.)
Public propertyHasMessages
True if the code object has any generated messages.
(Inherited from CodeObject.)
Public propertyHasNoIndentation
Determines if the code object has no indentation.
(Inherited from CodeObject.)
Public propertyHasNonEOLComments
True if the code object has any regular (non-doc) preceding (non-EOL, non-Infix, non-Postfix) comments.
(Inherited from CodeObject.)
Public propertyHasPostAnnotations
True if the code object has any postfix annotations.
(Inherited from CodeObject.)
Public propertyHasTerminator
Determines if the code object has a terminator character.
(Inherited from CodeObject.)
Public propertyHiddenRef
Any hidden reference to another CodeObject.
(Inherited from CodeObject.)
Public propertyInfixComment
The infix comment for the code object (if any).
(Inherited from CodeObject.)
Public propertyIsEOL
True if the annotation appears at the end-of-line (should only be true for EOL comments).
(Inherited from Annotation.)
Public propertyIsFirstOnLine
Determines if the code object appears as the first item on a line.
(Inherited from CodeObject.)
Public propertyIsFirstOnLineDefault
True if the code object defaults to starting on a new line.
(Inherited from CodeObject.)
Public propertyIsGenerated
Determines if the code object is generated.
(Inherited from CodeObject.)
Public propertyIsGroupingSet
Determines if the 'grouping' (has parens or braces) status has been set.
(Inherited from CodeObject.)
Public propertyIsInfix
True if this annotation is marked as any type of Infix location.
(Inherited from Annotation.)
Public propertyIsInfixLocation1
True if this annotation is marked as Infix location #1.
(Inherited from Annotation.)
Public propertyIsInfixLocation2
True if this annotation is marked as Infix location #1.
(Inherited from Annotation.)
Public propertyIsInfixLocation3
True if this annotation is marked as Infix location #1.
(Inherited from Annotation.)
Public propertyIsListed
True if the annotation should be listed at the CodeUnit and Solution levels (for display in an output window).
(Inherited from Annotation.)
Public propertyIsNewLinesSet
Determines if the newline count has been set on the code object.
(Inherited from CodeObject.)
Public propertyIsPostfix
True if this annotation appears after the object it's attached to as opposed to before it.
(Inherited from Annotation.)
Public propertyIsRenderable
True if the CodeObject is renderable.
(Inherited from CodeObject.)
Public propertyIsSingleLine
Determines if the code object only requires a single line for display.
(Inherited from DocComment.)
Public propertyIsSingleLineDefault
True if the code object only requires a single line for display by default.
(Inherited from CodeObject.)
Public propertyLineNumber
The line number associated with the CodeObject (if any, 0 if none).
(Inherited from CodeObject.)
Public propertyMissingEndTag
True if the documentation comment is missing an end tag.
(Inherited from DocComment.)
Public propertyMissingStartTag
True if the documentation comment is missing a start tag.
(Inherited from DocComment.)
Public propertyNewLines
The number of newlines preceding the object (0 to N).
(Inherited from CodeObject.)
Public propertyParent
The parent CodeObject.
(Inherited from CodeObject.)
Public propertyPostfixComment
The postfix comment for the code object (if any).
(Inherited from CodeObject.)
Public propertyPrefixSpaceCount
The count of prefix spaces (if any) before the comment delimiter.
(Inherited from CommentBase.)
Public propertyTagName
The XML tag name for the documentation comment.
(Overrides DocCommentTagName.)
Public propertyText
Get the annotation in text format.
(Inherited from Annotation.)
Top
See Also