MarkdownAddressingOptions.ApiTopicId Property

Namespace

Kampute.DocToolkit.Routing

Assembly

Kampute.DocToolkit.dll

Definition

Gets or sets the identifier of the topic that should serve as the introduction or overview of the API references.

public string ApiTopicId { get; set; }

Property Value

string: The identifier of the topic that should serve as the introduction or overview of the API references.

Remarks

When this property is not empty, the topic with the specified identifier is used as the API topic of the documentation, and all API references are placed under it. If the documentation context has no topic with this identifier, the addressing strategy throws an ArgumentException when it resolves API reference addresses.