MarkdownAddressingStrategy.IsMainTopic Method

Namespace

Kampute.DocToolkit.Routing

Assembly

Kampute.DocToolkit.dll

Definition

Determines whether the specified topic is the main topic of the documentation.

protected bool IsMainTopic(ITopic topic)

Parameters

topic ITopic: The topic to check.

Returns

bool: true if topic is a top-level topic whose identifier matches MarkdownAddressingOptions.MainTopicId; otherwise, false.

Exceptions

ArgumentNullException: Thrown when topic is null.

Remarks

Topic identifiers are compared case-insensitively, as the topic collection of a documentation context compares them.