CMakeBuildSettings Class

Summary

Contains settings for CMake build mode.
Assembly
Cake.CMake.dll
Namespace
Cake.CMake
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["CMakeBuildSettings"] class Type type-node

Syntax

public class CMakeBuildSettings : ToolSettings

Remarks

cmake --build <dir> [<options>] [-- <build-tool-options>]

Constructors

Name Summary
CMakeBuildSettings()

Properties

Name Value Summary
BinaryPath DirectoryPath
Gets or sets the project binary directory to be built.
CleanFirst bool
Gets or sets a value indicating whether build target clean first, then build. (To clean only, use --target clean.)
Configuration string
Gets or sets the configuration for multi-configuration tools. --config <cfg> The configuration.
Options ICollection<string>
Gets or sets CMake build options.
Targets ICollection<string>
Gets or sets the targets. Build passed target instead of the default target.

Extension Methods

Name Value Summary
Dump<CMakeBuildSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<CMakeBuildSettings>(CMakeBuildSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CMakeBuildSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CMakeBuildSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<CMakeBuildSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<CMakeBuildSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin