IDocumentationProvider Interface
Provides the base requirements of an object that can return documentation for a .NET type or member definition.
public interface IDocumentationProvider
Methods
GetParameter(String)
Returns the documentation for the parameter with the specified name.
string GetParameter(string name)
Parameter | Type | Description |
---|---|---|
name | System.String | The parameter name. |
Returns
- System.String:
The documentation for the parameter with the specified name.
GetSummary()
Returns the summary documentation.
string GetSummary()
Returns
- System.String:
The summary documentation.
GetTypeParameter(String)
Returns the documentation for the type parameter with the specified name.
string GetTypeParameter(string name)
Parameter | Type | Description |
---|---|---|
name | System.String | The parameter name. |
Returns
- System.String:
The documentation for the type parameter with the specified name.