DocumentationComposer.GenerateDocumentationForInterface Method

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Generates documentation pages for the specified interface type and its members.
protected virtual void GenerateDocumentationForInterface(IDocumentWriterFactory writerFactory, InterfaceModel interfaceType, PageGranularity granularity)

Parameters

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

Exceptions

ArgumentNullException
Thrown when writerFactory or interfaceType is null.

Remarks

This method processes an interface type and its members based on the specified granularity.
  • If the granularity includes PageGranularity.Type, a dedicated page is created for the interface.
  • If the granularity includes PageGranularity.Member, separate documentation pages are generated for each member of the interface. Otherwise, all member documentation is included on the interface page.