Kampute.DocToolkit.Topics Namespace

Contains models for conceptual documentation topics that complement API reference documentation.

Remarks

The models in this namespace represent conceptual documentation content such as explanatory material, guides, tutorials, and other non-reference documentation. These models support the integration of conceptual documentation with API reference documentation.

Classes

AdHocTopicRepresents a documentation topic that generates its content using a delegate.
FileTopicRepresents source of a documentation topic that reads content from a file.
HtmlFileTopicRepresents a documentation topic that is stored in an HTML file.
MarkdownFileTopicRepresents a documentation topic that is stored in a Markdown file.

Interfaces

IFileBasedTopicDefines a contract for a documentation topic that is based on a file system resource.
IMutableTopicDefines a contract for a mutable documentation topic that allows modification of the topic title and hierarchical relationships.
ITopicDefines a contract for a documentation topic.