DocListDescription Class

Create a DocListDescription.

Parse a DocListDescription.

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.

Accept the specified visitor object for the current code object and it's children.

Accept the specified visitor object for all regular (non-EOL, non-Infix, non-Postfix) annotations (comments, attributes, compiler directives).

Accept the specified visitor object for all specified Infix or Postfix annotations (comments, compiler directives).

Accept the specified visitor object for the content of the DocComment.

Accept the specified visitor object for all EOL comments.

Accept the specified visitor object for all Infix comments.

Accept the specified visitor object for all Infix EOL comments.

Add the specified text to the documentation comment.

Add the specified child DocComment to the documentation comment.

Add the specified DocComments to the documentation comment.

Determine if the specified comment should be associated with the current code object during parsing.

Render the entire code object as a string, using LFs for newlines.

Convert the code object to text with a trailing newline, and using CR/LF pairs for newlines (file format).

Convert the code object to text using the specified flags and format (file or string).

Render all regular (non-EOL, non-Infix, non-Postfix, non-Message) annotations (comments, attributes, compiler directives).

Render all specified Infix or Postfix annotations (comments, compiler directives).

Render all EOL comments.

Render all Infix comments with the specified mask.

Render all Infix EOL comments.

Render all regular annotations on the current object, or the left most binary operator.

Determine the length of the code object if converted to a string using the specified flags.

Attach an Annotation (Comment, DocComment, Attribute, CompilerDirective, or Message) to the CodeObject.

Attach an Annotation to the CodeObject at the specified position.

Create a comment object and attach it to the code object.

Create an EOL comment object and attach it to the code object.

Create a message and attach it to the code object.

Calculate metrics for this code object and its children.

Check for alignment of any EOL comments.

Deep-clone the code object.

Clone a field of a code object, including setting the parent.

Clone a field of a code object, including setting the parent.

Copy formatting from another code object.

Create the list of child Annotations, or return the existing one.

Create a reference to the CodeObject.

Default format the code object.

Default format the specified child field code object.

Determine a default of 1 or 2 newlines when adding items to a Block.

Dispose the CodeObject.

Determines whether the specified object is equal to the current object.

Evaluate the type or namespace associated with the code object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Find the parent object of the specified type.

Find the parent method (or anonymous method or lambda) of the current code object.

Find the parent method (or anonymous method or lambda) or type of the current code object.

Get an enumerator for all children objects of type T in the CodeObject and in any child CodeObjects (recursively).

Returns the first attribute expression (Call or ConstructorRef) with the specified name on the CodeObject.

Get the comment that satisfies the specified predicate.

Get a short text description of the CodeObject. This is generally the shortest text representation that uniquely identifies objects, even if they have the same name, for example: type or return type, name, type parameters, parameters.

Returns the DocSummary documentation comment, or null if none exists.

Serves as the default hash function.

Get the indent level of this object.

Get the current indent in spaces.

Determine the type of an inferred ('var') type.

Get the Namespace for this CodeObject.

Get the root documentation comment object.

Gets the Type of the current instance.

Get a TypeRef for the type with the specified full name, with caching (generally used for System types).

Get the type of the worst attached message.

Returns true if the attribute with the specified name exists on the object, otherwise false.

Returns true if the code object is an UnresolvedRef or has any UnresolvedRef children.

Returns true if the specified child object is indented from the parent.

Returns true if the specified child object is prefixed to the current object.

Creates a shallow copy of the current Object.

Move all (regular or EOL) comments from the specified token to the current code object, converting any EOL comments to regular comments (which will be rendered inline if necessary).

Move any annotations from the specified location to the specified destination location.

Move any non-EOL comments from the specified token to the current code object.

Move any non-EOL comments from the specified token to the current code object.

Move any non-EOL comments from the specified token to the current code object as Post comments.

Move any EOL or Postfix annotations from the specified code object to the current code object.

Move any EOL comment from the specified code object to the current code object.

Move any EOL comment from the specified token to the current code object.

Move any EOL comment from the specified token to the current code object.

Move any EOL comment from the specified token to the current code object as an Infix EOL comment.

Move formatting from the specified code object to the current object.

Move formatting from the specified token to the current object.

Move any prefix annotations on the specified code object to the current code object as the specified type of annotation.

Normalize content.

Propagate the listed annotation to the parent CodeUnit and above.

Remove the listed annotation from the parent CodeUnit and above.

Parse a DocListDescription.

Parse annotations - specifically, compiler directives around things such as TypeParameters or ParameterDecls.

Parse any comments, attributes, compiler directives.

Parse the content of a DocComment tag.

Parse the specified expected token, attaching a parse error to the current object if it doesn't exist.

Parse annotations from the Unused list.

Remove all annotations of the specified type from this object.

Remove all annotations from this object where the specified predicate is true.

Remove all messages from this object, or optionally only from the specified source.

Remove the attribute expression with the specified name.

Resolve all child symbolic references.

Resolve all child symbolic references, using the specified ResolveCategory and ResolveFlags.

Resolve any attached attributes.

Resolve any references in attached documentation comments.

Resolve child code objects that match the specified name are valid goto targets, moving up the tree until a complete match is found.

Resolve child code objects that match the specified name, moving up the tree until a complete match is found.

Similar to ResolveRefUp(String, Resolver), but skips trying to resolve the symbol in the body or parameters of a method (used for resolving parameter types).

Set a field of a code object, including setting the parent, and optional formatting.

Set a ChildList collection field of a code object, including setting the parent.

Set a field of a code object, including setting the parent, and optional formatting.

Set the line and column numbers to those in the specified CodeObject.

Set the line and column numbers to those in the specified token.

Special method to set the newline count without setting the NewLinesSet flag.

Set the starting line and column numbers to those in the specified token (used by some code objects with prefixes such as modifiers).

Render the type of the code object and its description as a string.

Recursively update the dictionary of names in the specified Block by either adding or removing (as specified by the 2nd parameter) all appropriate nested INamedCodeObjects expressions in the current CodeObject tree (specifically implemented for LocalDeclExpr expression objects).

Update the line and column numbers according to the current positions in the CodeWriter, if the UpdateLineCol flag is set.

Any Annotations (Comments, DocComments, Attributes, or Messages) associated with the CodeObject (null if none).

The starting column number associated with the CodeObject if parsed from or written to text form.

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.

Formatting flags - for line feeds, braces, etc.

The starting line number associated with the CodeObject if parsed from or written to text form.

The parent CodeObject.

The token used to parse the code object.