Skip to content

ICreateDocs Interface

Definition

A build which outputs documentation.

C#
public interface ICreateDocs : INukeBuild

Properties

Documentation

Gets the target to generate documentation.

C#
Target Documentation { get; }

DocumentationDirectory

Gets the directory to generate documentation from.

C#
[Parameter("The directory of the documentation source.")]
AbsolutePath DocumentationDirectory { get; }

DocumentationOutputDirectory

Gets the directory to output documentation in.

C#
[Parameter("The output directory of the generated documentation.")]
AbsolutePath DocumentationOutputDirectory { get; }

Methods

CreateDocs()

Generates documentation.

C#
void CreateDocs()