DocumentationComposer.GenerateDocumentationForTypes Method

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Generates documentation pages for the types in the specified collection.
protected virtual void GenerateDocumentationForTypes(IDocumentWriterFactory writerFactory, IReadOnlyTypeCollection types, PageGranularity granularity)

Parameters

writerFactory IDocumentWriterFactory
The factory for creating rendering contexts.
types IReadOnlyTypeCollection
The collection of types to document.
granularity PageGranularity
The page granularity that defines how the type and its members are organized in the documentation.

Exceptions

ArgumentNullException
Thrown when writerFactory or types is null.

Remarks

This method processes different type categories (classes, structs, interfaces, enums, delegates) and delegates each type to the appropriate specialized methods for generating their documentation.

The granularity parameter controls how documentation is organized, determining whether types and their members receive their own documentation pages.