DocumentationProvider Class
Returns documentation for a .NET type or member definition.
public class DocumentationProvider : IDocumentationProvider- Inheritance:
- object object
- Implements:
- IDocumentationProvider
Constructors
DocumentationProvider(string)
Initializes a new instance of the DocumentationProvider 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
- string:
The documentation key for the specified ITypeDefinition.
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
- string:
The documentation key for the specified ITypeMemberDefinition.
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
- string:
The documentation for the parameter with the specified name.
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
- string:
The documentation for the type parameter with the specified name.
ToString()
Returns a String that represents the current Object.