C# Class 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

Inheritance: IDocumentationProvider

Mostra file Open project: danieleli/Swagger.Net Class Usage Examples

Public Methods

Method	Description
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

Private Methods

Method	Description
GetActionDocumentation ( HttpActionDescriptor actionDescriptor, string selector ) : string
GetGenericResponseClass ( MethodInfo methodInfo ) : string
GetMethodNode ( HttpActionDescriptor actionDescriptor ) : XPathNavigator
GetMethodSignature ( MethodInfo method ) : string
GetNodeText ( XPathNavigator node, string selector ) : 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

GetDocumentation() public method

public GetDocumentation ( PropertyInfo propInfo ) : string
propInfo	System.Reflection.PropertyInfo
return	string

GetDocumentation() public method

public GetDocumentation ( Type type ) : string
type	System.Type
return	string

GetDocumentation() public method

public GetDocumentation ( XPathNavigator node ) : string
node	System.Xml.XPath.XPathNavigator
return	string

GetRemarks() public method

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

GetRemarks() public method

public GetRemarks ( Type type ) : string
type	System.Type
return	string

GetResponseClass() public method

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

XmlCommentDocumentationProvider() public method

public XmlCommentDocumentationProvider ( string documentPath ) : System
documentPath	string
return	System