DocumentationComposer.GenerateDocumentationForEnum Method

Namespace

Kampute.DocToolkit

Assembly

Kampute.DocToolkit.dll

Definition

Generates documentation page for the specified enum type.

protected virtual void GenerateDocumentationForEnum(IDocumentWriterFactory writerFactory, EnumModel enumType)

Parameters

writerFactory IDocumentWriterFactory: The factory for creating rendering contexts.
enumType EnumModel: The enum type to document.

Exceptions

ArgumentNullException: Thrown when writerFactory or enumType is null.

Remarks

This method processes an enumeration type to generate its documentation.