DocumentationComposer.GenerateDocumentationForNamespace Method

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Generates documentation pages for the specified namespace and the types it contains.
protected virtual void GenerateDocumentationForNamespace(IDocumentWriterFactory writerFactory, NamespaceModel ns, PageGranularity granularity)

Parameters

writerFactory IDocumentWriterFactory
The factory for creating rendering contexts.
ns NamespaceModel
The namespace to document.
granularity PageGranularity
The page granularity that defines how the namespace and its types are organized in the documentation.

Exceptions

ArgumentNullException
Thrown when writerFactory or ns is null.

Remarks

This method processes a namespace and its types based on the specified granularity. The granularity parameter determines whether the namespace and its types receive their own dedicated documentation pages.