Files
linux-packaging-mono/external/aspnetwebstack/src/System.Web.Http/Description/IDocumentationProvider.cs
Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

27 lines
1.0 KiB
C#

// Copyright (c) Microsoft Corporation. All rights reserved. See License.txt in the project root for license information.
using System.Web.Http.Controllers;
namespace System.Web.Http.Description
{
/// <summary>
/// Defines the provider responsible for documenting the service.
/// </summary>
public interface IDocumentationProvider
{
/// <summary>
/// Gets the documentation based on <see cref="HttpActionDescriptor"/>.
/// </summary>
/// <param name="actionDescriptor">The action descriptor.</param>
/// <returns>Documentation for the controller.</returns>
string GetDocumentation(HttpActionDescriptor actionDescriptor);
/// <summary>
/// Gets the documentation based on <see cref="HttpParameterDescriptor"/>.
/// </summary>
/// <param name="parameterDescriptor">The parameter descriptor.</param>
/// <returns>Documentation for the controller.</returns>
string GetDocumentation(HttpParameterDescriptor parameterDescriptor);
}
}