In This Article

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

GetRemarks()

Returns the remarks documentation.

string GetRemarks()

Returns

string

GetSummary()

Returns the summary documentation.

string GetSummary()

Returns

string

GetTypeParameter(string)

Returns the documentation for the type parameter with the specified name.

string GetTypeParameter(string name)
Parameter Type Description
name string

The parameter name.

Returns

string

Extension Methods