ICreateDoxygen Interface

Definition

A build which outputs Doxygen documentation.

public interface ICreateDoxygen : ICreateDocs, INukeBuild

Gets the directory to run CMake from.

RelativePath CMakeDirectory { get; }

This assumes the folder containing this Nuke build is two folders away from the primary CMakeLists.txt file.

Gets the CMake project generator to use.

string CMakeGeneratedProjectType { get; }

Gets the CMake project platform to generate.

string CMakeGeneratedProjectPlatform { get; }

Gets the folder to generate CMake projects in.

AbsolutePath CMakeGeneratedProjectDirectory { get; }

Gets the folder name of the CMake documentation project.

string DocumentationProjectName { get; }

Gets the file name of the CMake documentation project.

string DocumentationProjectFileName { get; }

Gets the CMake project configuration to generate.

string CMakeGeneratedProjectConfiguration { get; }

Runs Doxygen.

void RunDoxygen()