C# Class App.Web.Areas.HelpPage.XmlDocumentationProvider

A custom IDocumentationProvider that reads the API documentation from an XML documentation file.

Inheritance: IDocumentationProvider

Show file Open project: kriasoft/site-sdk

Public Methods

Method	Description
GetDocumentation ( HttpActionDescriptor actionDescriptor ) : string
GetDocumentation ( HttpParameterDescriptor parameterDescriptor ) : string
XmlDocumentationProvider ( string documentPath ) : System	Initializes a new instance of the XmlDocumentationProvider class.

Private Methods

Method	Description
GetMemberName ( MethodInfo method ) : string
GetMethodNode ( HttpActionDescriptor actionDescriptor ) : XPathNavigator
GetTypeName ( Type type ) : string

Method Details

GetDocumentation() public method

public GetDocumentation ( HttpActionDescriptor actionDescriptor ) : string
actionDescriptor	HttpActionDescriptor
return	string

GetDocumentation() public method

public GetDocumentation ( HttpParameterDescriptor parameterDescriptor ) : string
parameterDescriptor	HttpParameterDescriptor
return	string

XmlDocumentationProvider() public method

Initializes a new instance of the XmlDocumentationProvider class.

public XmlDocumentationProvider ( string documentPath ) : System
documentPath	string	The physical path to XML document.
return	System