Class DocumentationComment

Inheritance
object
DocumentationComment
Namespace: Neon.Roslyn
Assembly: Neon.Roslyn.dll
Syntax
public class DocumentationComment

Constructors

DocumentationComment(string, DocumentationItem[], DocumentationItem[], string, string, string, string, DocumentationItem[])

Declaration
public DocumentationComment(string summaryText = "", DocumentationItem[] typeParamElements = null, DocumentationItem[] paramElements = null, string returnsText = "", string remarksText = "", string exampleText = "", string valueText = "", DocumentationItem[] exception = null)
Parameters
Type Name Description
string summaryText
DocumentationItem[] typeParamElements
DocumentationItem[] paramElements
string returnsText
string remarksText
string exampleText
string valueText
DocumentationItem[] exception

Fields

Empty

Declaration
public static readonly DocumentationComment Empty
Field Value
Type Description
DocumentationComment

Properties

ExampleText

Declaration
public string ExampleText { get; }
Property Value
Type Description
string

Exception

Declaration
public DocumentationItem[] Exception { get; }
Property Value
Type Description
DocumentationItem[]

ParamElements

Declaration
public DocumentationItem[] ParamElements { get; }
Property Value
Type Description
DocumentationItem[]

RemarksText

Declaration
public string RemarksText { get; }
Property Value
Type Description
string

ReturnsText

Declaration
public string ReturnsText { get; }
Property Value
Type Description
string

SummaryText

Declaration
public string SummaryText { get; }
Property Value
Type Description
string

TypeParamElements

Declaration
public DocumentationItem[] TypeParamElements { get; }
Property Value
Type Description
DocumentationItem[]

ValueText

Declaration
public string ValueText { get; }
Property Value
Type Description
string

Methods

From(string, string)

Declaration
public static DocumentationComment From(string xmlDocumentation, string lineEnding)
Parameters
Type Name Description
string xmlDocumentation
string lineEnding
Returns
Type Description
DocumentationComment

GetParameterText(string)

Declaration
public string GetParameterText(string name)
Parameters
Type Name Description
string name
Returns
Type Description
string

GetTypeParameterText(string)

Declaration
public string GetTypeParameterText(string name)
Parameters
Type Name Description
string name
Returns
Type Description
string