1 // Copyright (c) Microsoft Corporation. All rights reserved. See License.txt in the project root for license information. 2 3 using System.Web.Http.Controllers; 4 5 namespace System.Web.Http.Description 6 { 7 /// <summary> 8 /// Defines the provider responsible for documenting the service. 9 /// </summary> 10 public interface IDocumentationProvider 11 { 12 /// <summary> 13 /// Gets the documentation based on <see cref="HttpActionDescriptor"/>. 14 /// </summary> 15 /// <param name="actionDescriptor">The action descriptor.</param> 16 /// <returns>Documentation for the controller.</returns> GetDocumentation(HttpActionDescriptor actionDescriptor)17 string GetDocumentation(HttpActionDescriptor actionDescriptor); 18 19 /// <summary> 20 /// Gets the documentation based on <see cref="HttpParameterDescriptor"/>. 21 /// </summary> 22 /// <param name="parameterDescriptor">The parameter descriptor.</param> 23 /// <returns>Documentation for the controller.</returns> GetDocumentation(HttpParameterDescriptor parameterDescriptor)24 string GetDocumentation(HttpParameterDescriptor parameterDescriptor); 25 } 26 } 27