DocumentationComposer.GenerateDocumentationForClass Method

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Generates documentation pages for the specified class type and its members.
protected virtual void GenerateDocumentationForClass(IDocumentWriterFactory writerFactory, ClassModel classType, PageGranularity granularity)

Parameters

writerFactory IDocumentWriterFactory
The factory for creating rendering contexts.
classType ClassModel
The class type to document.
granularity PageGranularity
The page granularity that defines how the class and its members are organized in the documentation.

Exceptions

ArgumentNullException
Thrown when writerFactory or classType is null.

Remarks

This method processes a class type and its members based on the specified granularity.
  • If the granularity includes PageGranularity.Type, a dedicated page is created for the class.
  • If the granularity includes PageGranularity.Member, separate documentation pages are generated for each member of the class. Otherwise, all member documentation is included on the class page.
The method also recursively processes any nested types declared within the class.