C# Class WebApiContrib.Tracing.Slab.DemoApp.Areas.HelpPage.XmlDocumentationProvider

A custom IDocumentationProvider that reads the API documentation from an XML documentation file.
Inheritance: IDocumentationProvider, IModelDocumentationProvider
Afficher le fichier Open project: WebApiContrib/WebApiContrib.Tracing.Slab

Méthodes publiques

Méthode Description
GetDocumentation ( HttpActionDescriptor actionDescriptor ) : string
GetDocumentation ( HttpControllerDescriptor controllerDescriptor ) : string
GetDocumentation ( HttpParameterDescriptor parameterDescriptor ) : string
GetDocumentation ( MemberInfo member ) : string
GetDocumentation ( Type type ) : string
GetResponseDocumentation ( HttpActionDescriptor actionDescriptor ) : string
XmlDocumentationProvider ( string documentPath ) : System

Initializes a new instance of the XmlDocumentationProvider class.

Private Methods

Méthode Description
GetMemberName ( MethodInfo method ) : string
GetMethodNode ( HttpActionDescriptor actionDescriptor ) : XPathNavigator
GetTagValue ( XPathNavigator parentNode, string tagName ) : string
GetTypeName ( Type type ) : string
GetTypeNode ( Type type ) : XPathNavigator

Method Details

GetDocumentation() public méthode

public GetDocumentation ( HttpActionDescriptor actionDescriptor ) : string
actionDescriptor HttpActionDescriptor
Résultat string

GetDocumentation() public méthode

public GetDocumentation ( HttpControllerDescriptor controllerDescriptor ) : string
controllerDescriptor HttpControllerDescriptor
Résultat string

GetDocumentation() public méthode

public GetDocumentation ( HttpParameterDescriptor parameterDescriptor ) : string
parameterDescriptor HttpParameterDescriptor
Résultat string

GetDocumentation() public méthode

public GetDocumentation ( MemberInfo member ) : string
member System.Reflection.MemberInfo
Résultat string

GetDocumentation() public méthode

public GetDocumentation ( Type type ) : string
type System.Type
Résultat string

GetResponseDocumentation() public méthode

public GetResponseDocumentation ( HttpActionDescriptor actionDescriptor ) : string
actionDescriptor HttpActionDescriptor
Résultat string

XmlDocumentationProvider() public méthode

Initializes a new instance of the XmlDocumentationProvider class.
public XmlDocumentationProvider ( string documentPath ) : System
documentPath string The physical path to XML document.
Résultat System