DocumentationComposer.GenerateDocumentationForEvents Method

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Generates documentation pages for the specified events.
protected virtual void GenerateDocumentationForEvents(IDocumentWriterFactory writerFactory, IEnumerable<EventModel> events)

Parameters

writerFactory IDocumentWriterFactory
The factory for creating rendering contexts.
events IEnumerable<EventModel>
The events to document.

Exceptions

ArgumentNullException
Thrown when writerFactory or events is null.

Remarks

This method processes events, generating documentation pages for each event in the collection.