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 | 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.