ITopic Interface

Namespace
Kampute.DocToolkit.Topics
Assembly
  • Kampute.DocToolkit.dll

Definition

Defines a contract for a documentation topic.
public interface ITopic
Implemented by

Remarks

The ITopic interface represents a discrete content piece such as a conceptual guide, tutorial, or overview page that complements the automatically generated API reference.

Topics allow content in a format different from the target documentation format to be represented in the final documentation. For example, Markdown files can be rendered as HTML through appropriate transformation.

Implementations work with IDocumentationContext to access formatting, linking, and other documentation services during rendering.

Properties

IdGets the unique identifier of the topic among its siblings.
ParentTopicGets the parent topic of the topic.
SubtopicsGets the subtopics of the topic.
TitleGets the title of the topic.

Methods

Render(TextWriter, IDocumentationContext)Renders the content of the topic to the specified TextWriter.