DocumentationComposer.GenerateDocumentationForStruct Method

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Generates documentation pages for the specified struct type and its members.
protected virtual void GenerateDocumentationForStruct(IDocumentWriterFactory writerFactory, StructModel structType, PageGranularity granularity)

Parameters

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

Exceptions

ArgumentNullException
Thrown when writerFactory or structType is null.

Remarks

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