DotNetApiOptions Class

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Provides options for generating documentation addresses compatible with .NET API documentation.
public class DotNetApiOptions : HtmlAddressingOptions
Inheritance

Remarks

The DotNetApiOptions class provides configuration for documentation file addressing specifically tailored to match the structure of official .NET API documentation.

This class implements the following default configuration:
  • Sets file extension to HTML (.html)
  • Includes file extensions in generated URLs
  • Uses the api path for API documentation
  • Places top-level topic files in the root directory
While official .NET documentation URLs don't have file extensions, this implementation includes them for better web server compatibility by default.

Constructors

DotNetApiOptions()Initializes a new instance of the DotNetApiOptions class.

See Also