Interface ICreateDocs

A build which outputs documentation.

Inherited Members
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 ICreateDocs : INukeBuild

Properties

View Source

Documentation

Gets the target to generate documentation.

Declaration
Target Documentation { get; }
Property Value
Type Description
Target
View Source

DocumentationDirectory

Gets the directory to generate documentation from.

Declaration
[Parameter("The directory of the documentation source.")]
AbsolutePath DocumentationDirectory { get; }
Property Value
Type Description
AbsolutePath
View Source

DocumentationOutputDirectory

Gets the directory to output documentation in.

Declaration
[Parameter("The output directory of the generated documentation.")]
AbsolutePath DocumentationOutputDirectory { get; }
Property Value
Type Description
AbsolutePath

Methods

View Source

CreateDocs()

Generates documentation.

Declaration
void CreateDocs()

Extension Methods