FileSystemDocumentationComposer.GenerateDocumentation Method

Namespace

Kampute.DocToolkit

Assembly

Kampute.DocToolkit.dll

Definition

Generates documentation pages for the specified context and writes the output to the specified folder.

public virtual void GenerateDocumentation(IDocumentationContext documentationContext, string outputFolder, OutputOptions options = null)

Parameters

documentationContext IDocumentationContext: The documentation context.
outputFolder string: The output folder for the documentation files.
options OutputOptions optional: The options for output generation.

Exceptions

ArgumentNullException: Thrown when documentationContext or outputFolder is null.
NotSupportedException: Throw when the format of a documentation topic is not supported.