C# Класс ArmRest.Areas.HelpPage.XmlDocumentationProvider

A custom IDocumentationProvider that reads the API documentation from an XML documentation file.
Наследование: IDocumentationProvider, IModelDocumentationProvider
Показать файл Открыть проект

Открытые методы

Метод Описание
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.

Приватные методы

Метод Описание
GetMemberName ( MethodInfo method ) : string
GetMethodNode ( HttpActionDescriptor actionDescriptor ) : XPathNavigator
GetTagValue ( XPathNavigator parentNode, string tagName ) : string
GetTypeName ( Type type ) : string
GetTypeNode ( Type type ) : XPathNavigator

Описание методов

GetDocumentation() публичный метод

public GetDocumentation ( HttpActionDescriptor actionDescriptor ) : string
actionDescriptor HttpActionDescriptor
Результат string

GetDocumentation() публичный метод

public GetDocumentation ( HttpControllerDescriptor controllerDescriptor ) : string
controllerDescriptor HttpControllerDescriptor
Результат string

GetDocumentation() публичный метод

public GetDocumentation ( HttpParameterDescriptor parameterDescriptor ) : string
parameterDescriptor HttpParameterDescriptor
Результат string

GetDocumentation() публичный метод

public GetDocumentation ( MemberInfo member ) : string
member System.Reflection.MemberInfo
Результат string

GetDocumentation() публичный метод

public GetDocumentation ( Type type ) : string
type System.Type
Результат string

GetResponseDocumentation() публичный метод

public GetResponseDocumentation ( HttpActionDescriptor actionDescriptor ) : string
actionDescriptor HttpActionDescriptor
Результат string

XmlDocumentationProvider() публичный метод

Initializes a new instance of the XmlDocumentationProvider class.
public XmlDocumentationProvider ( string documentPath ) : System
documentPath string The physical path to XML document.
Результат System