Class HelpPageConfig<TAuthenticationToken>
A start-up configuration class for the auto documenting features.
Inheritance
System.Object
HelpPageConfig<TAuthenticationToken>
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Cqrs.WebApi
Assembly: Cqrs.WebApi.dll
Syntax
public static class HelpPageConfig<TAuthenticationToken>
Type Parameters
Name | Description |
---|---|
TAuthenticationToken | The System.Type of the authentication token. |
Properties
AssemblyXmlFileNames
The list of relevant XML files to use with the auto documenting feature.
Declaration
public static IList<string> AssemblyXmlFileNames { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<System.String> |
Methods
CreateXmlDocumentation()
Generate the relevant XML file used by the auto documenting feature.
Declaration
public static void CreateXmlDocumentation()
GenerateAssemblyXmlFileNames()
Generate a list of relevant XML files to use with the auto documenting feature.
Declaration
public static void GenerateAssemblyXmlFileNames()
GetBasicSampleObjects()
Get a collection of sample objects for the auto documenting features to use.
Declaration
public static IDictionary<Type, object> GetBasicSampleObjects()
Returns
Type | Description |
---|---|
System.Collections.Generic.IDictionary<System.Type, System.Object> |