C# (CSharp) ValetKey.Web.Areas.HelpPage Namespace

Nested Namespaces

ValetKey.Web.Areas.HelpPage.Controllers
ValetKey.Web.Areas.HelpPage.ModelDescriptions
ValetKey.Web.Areas.HelpPage.Models

Classes

Name Description
ApiDescriptionExtensions
HelpPageAreaRegistration
HelpPageConfig Use this class to customize the Help Page. For example you can set a custom System.Web.Http.Description.IDocumentationProvider to supply the documentation or you can provide the samples for the requests/responses.
HelpPageConfigurationExtensions
HelpPageSampleGenerator This class will generate the samples for the help page.
HelpPageSampleKey This is used to identify the place where the sample should be applied.
ImageSample This represents an image sample on the help page. There's a display template named ImageSample associated with this class.
InvalidSample This represents an invalid sample on the help page. There's a display template named InvalidSample associated with this class.
ObjectGenerator This class will create an object of a given type and populate it with sample data.
ObjectGenerator.SimpleTypeObjectGenerator
TextSample This represents a preformatted text sample on the help page. There's a display template named TextSample associated with this class.
XmlDocumentationProvider A custom IDocumentationProvider that reads the API documentation from an XML documentation file.