C# Class WebRole.Areas.HelpPage.XmlDocumentationProvider

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

Inheritance: IDocumentationProvider

Datei anzeigen Open project: LeKiosqueFr/git-to-azure-poc

Public Methods

Method	Description
GetDocumentation ( HttpActionDescriptor actionDescriptor ) : string
GetDocumentation ( HttpControllerDescriptor controllerDescriptor ) : string
GetDocumentation ( HttpParameterDescriptor parameterDescriptor ) : string
GetResponseDocumentation ( HttpActionDescriptor actionDescriptor ) : 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
GetTagValue ( XPathNavigator parentNode, string tagName ) : string
GetTypeName ( Type type ) : string
GetTypeNode ( HttpControllerDescriptor controllerDescriptor ) : XPathNavigator

Method Details

GetDocumentation() public method

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

GetDocumentation() public method

public GetDocumentation ( HttpControllerDescriptor controllerDescriptor ) : string
controllerDescriptor	HttpControllerDescriptor
return	string

GetDocumentation() public method

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

GetResponseDocumentation() public method

public GetResponseDocumentation ( HttpActionDescriptor actionDescriptor ) : string
actionDescriptor	HttpActionDescriptor
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