DocumentationComposer.GenerateDocumentation Method

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Generates documentation pages for the specified documentation context.
public virtual void GenerateDocumentation(IDocumentWriterFactory writerFactory, IDocumentationContext documentationContext)

Parameters

writerFactory IDocumentWriterFactory
The factory for creating rendering contexts.
documentationContext IDocumentationContext
The documentation context.

Exceptions

ArgumentNullException
Thrown when writerFactory or documentationContext is null.
NotSupportedException
Throw when the format of a documentation topic is not supported by the renderer.

Remarks

This method initiates the documentation generation process by iterating through all namespaces, types, type members, and topics in the provided context. For each element, it delegates to specialized methods for generating appropriate documentation pages.

The page granularity of the documentation context defines which code elements receive their own dedicated files.