XmlDocumentationProvider Class

  • Reference

Definition

Namespace:
Microsoft.WindowsAzure.Mobile.Service.Description
Assembly:
Microsoft.WindowsAzure.Mobile.Service.dll
Package:
WindowsAzure.MobileServices.Backend v1.0.478

A custom System.Web.Http.Description.IDocumentationProvider that reads the API documentation from XML documentation files located in the application area.

public class XmlDocumentationProvider : System.Web.Http.Description.IDocumentationProvider
type XmlDocumentationProvider = class
    interface IDocumentationProvider
Public Class XmlDocumentationProvider
Implements IDocumentationProvider
Inheritance
Object
XmlDocumentationProvider
Implements
System.Web.Http.Description.IDocumentationProvider

Constructors

XmlDocumentationProvider(ApiServices)

Initializes a new instance of the XmlDocumentationProvider class.

Methods

EnumerateDocFiles(String)
GetDocumentation(HttpActionDescriptor)

Gets the controller action documentation based on an System.Web.Http.Controllers.HttpActionDescriptor.
GetDocumentation(HttpControllerDescriptor)

Gets the controller documentation based on an System.Web.Http.Controllers.HttpControllerDescriptor.
GetDocumentation(HttpParameterDescriptor)

Gets the action parameter documentation based on an System.Web.Http.Controllers.HttpParameterDescriptor.
GetDocumentNavigators(ApiServices)

Gets the bin directory for the application and enumerates XML documentation files.
GetMethodNodeDocumentation(MethodInfo, String)
GetResponseDocumentation(HttpActionDescriptor)

Gets the action response documentation based on an System.Web.Http.Controllers.HttpActionDescriptor.
GetTagValue(XPathNavigator, String)
GetTypeNodeDocumentation(Type, String)
SelectNode(String)

Applies to