Compartilhar via


XmlDocumentationProvider.GetDocumentation Método

Definição

Sobrecargas

GetDocumentation(HttpActionDescriptor)

Obtém a documentação de ação do controlador com base em um System.Web.Http.Controllers.HttpActionDescriptor.

GetDocumentation(HttpControllerDescriptor)

Obtém a documentação do controlador com base em um System.Web.Http.Controllers.HttpControllerDescriptor.

GetDocumentation(HttpParameterDescriptor)

Obtém a documentação do parâmetro de ação com base em um System.Web.Http.Controllers.HttpParameterDescriptor.

GetDocumentation(HttpActionDescriptor)

Obtém a documentação de ação do controlador com base em um 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

Parâmetros

actionDescriptor
System.Web.Http.Controllers.HttpActionDescriptor

O System.Web.Http.Controllers.HttpActionDescriptor que identifica a ação do controlador.

Retornos

Um String que contém a documentação.

Implementações

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

Aplica-se a

GetDocumentation(HttpControllerDescriptor)

Obtém a documentação do controlador com base em um 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

Parâmetros

controllerDescriptor
System.Web.Http.Controllers.HttpControllerDescriptor

O System.Web.Http.Controllers.HttpControllerDescriptor que identifica o controlador.

Retornos

Um String que contém a documentação.

Implementações

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

Aplica-se a

GetDocumentation(HttpParameterDescriptor)

Obtém a documentação do parâmetro de ação com base em um 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

Parâmetros

parameterDescriptor
System.Web.Http.Controllers.HttpParameterDescriptor

O System.Web.Http.Controllers.HttpParameterDescriptor que identifica o parâmetro de ação.

Retornos

Um String que contém a documentação.

Implementações

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

Aplica-se a