DocumentationComposer.GenerateDocumentationForConstructors Method

Namespace

Kampute.DocToolkit

Assembly

Kampute.DocToolkit.dll

Definition

Generates documentation page for the specified constructors.

protected virtual void GenerateDocumentationForConstructors(IDocumentWriterFactory writerFactory, IReadOnlyList<ConstructorModel> constructors)

Parameters

writerFactory IDocumentWriterFactory: The factory for creating rendering contexts.
constructors IReadOnlyList<ConstructorModel>: The constructors to document.

Exceptions

ArgumentNullException: Thrown when writerFactory or constructors is null.

Remarks

This method processes constructors of a type. Regardless of the number of constructors, it creates a single documentation page.