DirectoryAliases.

CleanDirectory(ICakeContext, DirectoryPath, CleanDirectorySettings) Method

Summary

Cleans the specified directory.
Namespace
Cake.Common.IO
Containing Type
DirectoryAliases

Syntax

[CakeMethodAlias]
[CakeAliasCategory("Clean")]
public static void CleanDirectory(this ICakeContext context, DirectoryPath path, CleanDirectorySettings settings)

Examples

CleanDirectory("./src/Cake.Common/obj", new CleanDirectorySettings {
    Force = true
});

Attributes

Type Description
CakeMethodAliasAttribute An attribute used to mark script method aliases.
CakeAliasCategoryAttribute An attribute used for documentation of alias methods/properties.

Parameters

Name Type Description
context ICakeContext The context.
path DirectoryPath The directory path.
settings CleanDirectorySettings The clean settings.

Return Value

Type Description
void