MultiXmlDocumentationProvider Class

Namespace:
Weavy.Web.Areas.Docs
Assembly:
Weavy.Web.dll

A custom System.Web.Http.Description.IDocumentationProvider that reads the API documentation from an XML documentation file, See https://stackoverflow.com/questions/22165724/web-api-help-page-xml-comments-from-more-than-1-files.

public class MultiXmlDocumentationProvider : IExtraDocumentationProvider, IDocumentationProvider
Inheritance:
System.Object → MultiXmlDocumentationProvider
Implements:
IExtraDocumentationProvider

Constructors

MultiXmlDocumentationProvider(String[]) Initializes a new instance of the MultiXmlDocumentationProvider class.

Methods

GetDocumentation(HttpActionDescriptor) Get method documentation from method <summary> mode.
GetDocumentation(HttpControllerDescriptor) Get controller documentation from class <summary> node.
GetDocumentation(HttpParameterDescriptor) Get parameter documentation from the <param> node.
GetExampleDocumentation(HttpActionDescriptor) Get the value of the <example> element.
GetPropertyDocumentation(Type, string) Gets the <summary> documentation for the specified property.
GetRemarksDocumentation(HttpActionDescriptor) Get the value of the <remarks></returns> element.
GetRemarksDocumentation(Type) Gets the <remarks> of the class with the specified System.Type
GetResponseDocumentation(HttpActionDescriptor) Get method reponse documentation from the <returns> node.
GetReturnsDocumentation(HttpActionDescriptor) Get the value of the <returns></returns> element.
GetSummaryDocumentation(Type) Gets the <summary> of the class with the specified System.Type

Extension Methods

Serialize(object) Serializes an object, or graph of connected objects, to a byte array.
SerializeToJson(object, Formatting?, JsonSerializerSettings) Serializes an object, or graph of connected objects, to a json string.
IsValid(object) Determines whether the specified object is valid by evaluating each ValidationAttribute instance that is attached to the object type.