XmlDocumentationProvider.GetDocumentation Method

  • Reference

Definition

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

Overloads

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.

GetDocumentation(HttpActionDescriptor)

Gets the controller action documentation based on an System.Web.Http.Controllers.HttpActionDescriptor.

public virtual string GetDocumentation (System.Web.Http.Controllers.HttpActionDescriptor actionDescriptor);
abstract member GetDocumentation : System.Web.Http.Controllers.HttpActionDescriptor -> string
override this.GetDocumentation : System.Web.Http.Controllers.HttpActionDescriptor -> string
Public Overridable Function GetDocumentation (actionDescriptor As HttpActionDescriptor) As String

Parameters

actionDescriptor
System.Web.Http.Controllers.HttpActionDescriptor

The System.Web.Http.Controllers.HttpActionDescriptor identifying the controller action.

Returns

String

A String containing the documentation.

Implements

System.Web.Http.Description.IDocumentationProvider.GetDocumentation(System.Web.Http.Controllers.HttpActionDescriptor)

Applies to

GetDocumentation(HttpControllerDescriptor)

Gets the controller documentation based on an System.Web.Http.Controllers.HttpControllerDescriptor.

public virtual string GetDocumentation (System.Web.Http.Controllers.HttpControllerDescriptor controllerDescriptor);
abstract member GetDocumentation : System.Web.Http.Controllers.HttpControllerDescriptor -> string
override this.GetDocumentation : System.Web.Http.Controllers.HttpControllerDescriptor -> string
Public Overridable Function GetDocumentation (controllerDescriptor As HttpControllerDescriptor) As String

Parameters

controllerDescriptor
System.Web.Http.Controllers.HttpControllerDescriptor

The System.Web.Http.Controllers.HttpControllerDescriptor identifying the controller.

Returns

String

A String containing the documentation.

Implements

System.Web.Http.Description.IDocumentationProvider.GetDocumentation(System.Web.Http.Controllers.HttpControllerDescriptor)

Applies to

GetDocumentation(HttpParameterDescriptor)

Gets the action parameter documentation based on an System.Web.Http.Controllers.HttpParameterDescriptor.

public virtual string GetDocumentation (System.Web.Http.Controllers.HttpParameterDescriptor parameterDescriptor);
abstract member GetDocumentation : System.Web.Http.Controllers.HttpParameterDescriptor -> string
override this.GetDocumentation : System.Web.Http.Controllers.HttpParameterDescriptor -> string
Public Overridable Function GetDocumentation (parameterDescriptor As HttpParameterDescriptor) As String

Parameters

parameterDescriptor
System.Web.Http.Controllers.HttpParameterDescriptor

The System.Web.Http.Controllers.HttpParameterDescriptor identifying the action parameter.

Returns

String

A String containing the documentation.

Implements

System.Web.Http.Description.IDocumentationProvider.GetDocumentation(System.Web.Http.Controllers.HttpParameterDescriptor)

Applies to