C# Класс Swagger.Net.XmlCommentDocumentationProvider

Accesses the XML doc blocks written in code to further document the API. All credit goes to: http://blogs.msdn.com/b/yaohuang1/archive/2012/05/21/asp-net-web-api-generating-a-web-api-help-page-using-apiexplorer.aspx
Наследование: IDocumentationProvider
Показать файл Открыть проект Примеры использования класса

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

Метод Описание
GetDocumentation ( HttpActionDescriptor actionDescriptor ) : string
GetDocumentation ( HttpParameterDescriptor parameterDescriptor ) : string
GetDocumentation ( PropertyInfo propInfo ) : string
GetDocumentation ( Type type ) : string
GetDocumentation ( XPathNavigator node ) : string
GetRemarks ( HttpActionDescriptor actionDescriptor ) : string
GetRemarks ( Type type ) : string
GetResponseClass ( HttpActionDescriptor actionDescriptor ) : string
XmlCommentDocumentationProvider ( string documentPath ) : System

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

Метод Описание
GetActionDocumentation ( HttpActionDescriptor actionDescriptor, string selector ) : string
GetGenericResponseClass ( MethodInfo methodInfo ) : string
GetMethodNode ( HttpActionDescriptor actionDescriptor ) : XPathNavigator
GetMethodSignature ( MethodInfo method ) : string
GetNodeText ( XPathNavigator node, string selector ) : string

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

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

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

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

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

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

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

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

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

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

public GetDocumentation ( XPathNavigator node ) : string
node System.Xml.XPath.XPathNavigator
Результат string

GetRemarks() публичный Метод

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

GetRemarks() публичный Метод

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

GetResponseClass() публичный Метод

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

XmlCommentDocumentationProvider() публичный Метод

public XmlCommentDocumentationProvider ( string documentPath ) : System
documentPath string
Результат System