DocumentationComposer.GenerateDocumentationForTopic Method

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Generates documentation page for the specified topic.
protected virtual void GenerateDocumentationForTopic(IDocumentWriterFactory writerFactory, TopicModel topic)

Parameters

writerFactory IDocumentWriterFactory
The factory for creating rendering contexts.
topic TopicModel
The topic to document.

Exceptions

ArgumentNullException
Thrown when writerFactory or topic is null.

Remarks

This method creates a documentation page for a topic. Subtopics are not processed; they must be included in the topics collection of the documentation context to be documented.