Class DocumentationComment
- Namespace
- Alternet.Syntax.Parsers.Roslyn.CodeCompletion
- Assembly
- Alternet.Syntax.Parsers.Roslyn.v9.dll
A documentation comment derived from either source text or metadata.
public sealed class DocumentationComment- Inheritance
-
DocumentationComment
Fields
- Empty
An empty comment.
Properties
- ExampleText
The text in the <example> tag. Null if no tag existed.
- ExceptionTypes
The types of items in <exception> tags.
- FullXmlFragment
The full XML text of this tag.
- HadXmlParseError
True if an error occurred when parsing.
- ParameterNames
The names of items in <param> tags.
- RemarksText
The text in the <remarks> tag. Null if no tag existed.
- ReturnsText
The text in the <returns> tag. Null if no tag existed.
- SummaryText
The text in the <summary> tag. Null if no tag existed.
- TypeParameterNames
The names of items in <typeparam> tags.
Methods
- FromXmlFragment(string)
Parses and constructs a DocumentationComment from the given fragment of XML.
- GetExceptionTexts(string)
Returns the texts for a given exception, or an empty ImmutableArray if no documentation was given for the exception.
- GetParameterText(string)
Returns the text for a given parameter, or null if no documentation was given for the parameter.
- GetTypeParameterText(string)
Returns the text for a given type parameter, or null if no documentation was given for the type parameter.