IDocumentationProvider.GetDocumentation Method

 

Namespace:   System.Web.Http.Description
Assembly:  System.Web.Http (in System.Web.Http.dll)

Overload List

	Name	Description
	GetDocumentation(HttpActionDescriptor)	Gets the documentation based on HttpActionDescriptor.
	GetDocumentation(HttpControllerDescriptor)
	GetDocumentation(HttpParameterDescriptor)	Gets the documentation based on HttpParameterDescriptor.

See Also

IDocumentationProvider Interface
System.Web.Http.Description Namespace

Return to top

IDocumentationProvider.GetDocumentation Method (HttpActionDescriptor)

Gets the documentation based on HttpActionDescriptor.

Syntax

string GetDocumentation(
    HttpActionDescriptor actionDescriptor
)

String^ GetDocumentation(
    HttpActionDescriptor^ actionDescriptor
)

abstract GetDocumentation : 
        actionDescriptor:HttpActionDescriptor -> string

Function GetDocumentation (
    actionDescriptor As HttpActionDescriptor
) As String

Parameters

• actionDescriptor
  Type: System.Web.Http.Controllers.HttpActionDescriptor

  The action descriptor.

Return Value

Type: System.String

The documentation for the controller.

Return to top

IDocumentationProvider.GetDocumentation Method (HttpControllerDescriptor)

Syntax

string GetDocumentation(
    HttpControllerDescriptor controllerDescriptor
)

String^ GetDocumentation(
    HttpControllerDescriptor^ controllerDescriptor
)

abstract GetDocumentation : 
        controllerDescriptor:HttpControllerDescriptor -> string

Function GetDocumentation (
    controllerDescriptor As HttpControllerDescriptor
) As String

Parameters

• controllerDescriptor
  Type: System.Web.Http.Controllers.HttpControllerDescriptor

Return Value

Type: System.String

Return to top

IDocumentationProvider.GetDocumentation Method (HttpParameterDescriptor)

Gets the documentation based on HttpParameterDescriptor.

Syntax

string GetDocumentation(
    HttpParameterDescriptor parameterDescriptor
)

String^ GetDocumentation(
    HttpParameterDescriptor^ parameterDescriptor
)

abstract GetDocumentation : 
        parameterDescriptor:HttpParameterDescriptor -> string

Function GetDocumentation (
    parameterDescriptor As HttpParameterDescriptor
) As String

Parameters

• parameterDescriptor
  Type: System.Web.Http.Controllers.HttpParameterDescriptor

  The parameter descriptor.

Return Value

Type: System.String

The documentation for the controller.

Return to top