DocumentationProvider Class
Returns documentation for a .NET type or member definition.
public class DocumentationProvider : IDocumentationProvider- Inheritance:
- object object
- Implements:
- IDocumentationProvider
Constructors
DocumentationProvider(string?)
Initializes an instance of the class.
public DocumentationProvider(string? documentation)| Parameter | Type | Description |
|---|---|---|
| documentation | string | The XML documentation. |
Methods
GetDocumentationKey(ITypeDefinition)
Returns the documentation key for the specified ITypeDefinition.
public static string GetDocumentationKey(ITypeDefinition typeDef)| Parameter | Type | Description |
|---|---|---|
| typeDef | ITypeDefinition | The ITypeDefinition to examine. |
Returns
GetDocumentationKey(ITypeMemberDefinition, bool)
Returns the documentation key for the specified ITypeMemberDefinition.
public static string GetDocumentationKey(ITypeMemberDefinition typeMemberDef, bool includeDeclaringType)| Parameter | Type | Description |
|---|---|---|
| typeMemberDef | ITypeMemberDefinition | The ITypeMemberDefinition to examine. |
| includeDeclaringType | bool | Whether to include the declaring type. |
Returns
GetParameter(string)
Returns the documentation for the parameter with the specified name.
public string GetParameter(string name)| Parameter | Type | Description |
|---|---|---|
| name | string | The parameter name. |
Returns
GetRemarks()
Returns the remarks documentation.
GetSummary()
Returns the summary documentation.
GetTypeParameter(string)
Returns the documentation for the type parameter with the specified name.
public string GetTypeParameter(string name)| Parameter | Type | Description |
|---|---|---|
| name | string | The parameter name. |
Returns
ToString()
Returns the string representation of this object.
Inherited Members
- object.GetType()
- object.MemberwiseClone()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()