DevOpsWikiOptions Class

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Provides options for generating documentation addresses compatible with Azure DevOps Wiki.
public class DevOpsWikiOptions : AddressingOptions
Inheritance

Remarks

The DevOpsWikiOptions class provides configuration for documentation file addressing specifically tailored for Azure DevOps Wiki compatibility.

This class implements the following default configuration:
  • Sets file extension to Markdown (.md)
  • Includes file extension in generated URLs
  • Use C# as for formatting member names

Constructors

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

Properties

ApiTopicIdGets or sets the identifier of the topic that should serve as the introduction or overview of the API references.
LanguageGets or sets the programming language formatter to be used for formatting member names.
MainTopicIdGets or sets the identifier of the topic that should serve as the main entry point for the documentation.

See Also