Swagger.Net.XmlCommentDocumentationProvider.GetDocumentation C# (CSharp) Method

GetDocumentation() public method

public GetDocumentation ( HttpActionDescriptor actionDescriptor ) : string
actionDescriptor HttpActionDescriptor
return string
        public string GetDocumentation(HttpActionDescriptor actionDescriptor)
        {
            var rtn = GetActionDocumentation(actionDescriptor, "summary");
            return rtn;
        }

Same methods

XmlCommentDocumentationProvider::GetDocumentation ( HttpParameterDescriptor parameterDescriptor ) : string
XmlCommentDocumentationProvider::GetDocumentation ( PropertyInfo propInfo ) : string
XmlCommentDocumentationProvider::GetDocumentation ( Type type ) : string
XmlCommentDocumentationProvider::GetDocumentation ( XPathNavigator node ) : string

Usage Example

Esempio n. 1
0
        /// <summary>
        /// Creates an api operation
        /// </summary>
        /// <param name="api">Description of the api via the ApiExplorer</param>
        /// <param name="docProvider">Access to the XML docs written in code</param>
        /// <returns>An api operation</returns>
        public static ResourceApiOperation CreateResourceApiOperation(ResourceListing r, ApiDescription api, XmlCommentDocumentationProvider docProvider)
        {
            ResourceApiOperation rApiOperation = new ResourceApiOperation()
            {
                httpMethod    = api.HttpMethod.ToString(),
                nickname      = docProvider.GetNickname(api.ActionDescriptor),
                responseClass = docProvider.GetResponseClass(api.ActionDescriptor),
                summary       = docProvider.GetDocumentation(api.ActionDescriptor),
                notes         = docProvider.GetNotes(api.ActionDescriptor),
                parameters    = new List <ResourceApiOperationParameter>(),
            };

            if (string.IsNullOrEmpty(rApiOperation.notes) || rApiOperation.notes.Equals("No Documentation Found."))
            {
                rApiOperation.notes = rApiOperation.summary;
            }
            return(rApiOperation);
        }
All Usage Examples Of Swagger.Net.XmlCommentDocumentationProvider::GetDocumentation