Interface ICreateDoxygen

A build which outputs Doxygen documentation.

Inherited Members

ICreateDocs.Documentation

ICreateDocs.DocumentationDirectory

ICreateDocs.DocumentationOutputDirectory

ICreateDocs.CreateDocs()

INukeBuild.ReportSummary(Configure<Dictionary<string, string>>)

INukeBuild.TryGetValue<T>(Expression<Func<T>>)

INukeBuild.TryGetValue<T>(Expression<Func<object>>)

INukeBuild.ExecutionPlan

INukeBuild.InvokedTargets

INukeBuild.SkippedTargets

INukeBuild.ScheduledTargets

INukeBuild.RunningTargets

INukeBuild.AbortedTargets

INukeBuild.FailedTargets

INukeBuild.SucceededTargets

INukeBuild.FinishedTargets

INukeBuild.IsSucceeding

INukeBuild.IsFailing

INukeBuild.IsFinished

INukeBuild.ExitCode

INukeBuild.RootDirectory

INukeBuild.TemporaryDirectory

INukeBuild.BuildAssemblyFile

INukeBuild.BuildAssemblyDirectory

INukeBuild.BuildProjectDirectory

INukeBuild.BuildProjectFile

INukeBuild.Verbosity

INukeBuild.Host

INukeBuild.Plan

INukeBuild.Help

INukeBuild.NoLogo

INukeBuild.IsLocalBuild

INukeBuild.IsServerBuild

INukeBuild.Continue

INukeBuild.Partition

Namespace: Microsoft.XboxStudios.NukeExt

Assembly: NukeExt.Components.dll

Syntax

public interface ICreateDoxygen : ICreateDocs, INukeBuild

Properties

CMakeDirectory

Gets the directory to run CMake from.

Declaration

RelativePath CMakeDirectory { get; }

Property Value

Type	Description
RelativePath

Remarks

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

CMakeGeneratedProjectConfiguration

Gets the CMake project configuration to generate.

Declaration

string CMakeGeneratedProjectConfiguration { get; }

Property Value

Type	Description
string

CMakeGeneratedProjectDirectory

Gets the folder to generate CMake projects in.

Declaration

AbsolutePath CMakeGeneratedProjectDirectory { get; }

Property Value

Type	Description
AbsolutePath

CMakeGeneratedProjectPlatform

Gets the CMake project platform to generate.

Declaration

string CMakeGeneratedProjectPlatform { get; }

Property Value

Type	Description
string

CMakeGeneratedProjectType

Gets the CMake project generator to use.

Declaration

string CMakeGeneratedProjectType { get; }

Property Value

Type	Description
string

DocumentationProjectFileName

Gets the file name of the CMake documentation project.

Declaration

string DocumentationProjectFileName { get; }

Property Value

Type	Description
string

DocumentationProjectName

Gets the folder name of the CMake documentation project.

Declaration

string DocumentationProjectName { get; }

Property Value

Type	Description
string

Methods

RunDoxygen()

Runs Doxygen.

Declaration

void RunDoxygen()

Extension Methods

NukeBuildExtensions.IsInterceptorExecution(INukeBuild)