DocFxMetadataAliases.

DocFxMetadata(ICakeContext, IEnumerable<FilePath>) Method

Summary

Extract API documentation using DocFx, with the specified project/source files or search patterns.
Assembly
Cake.DocFx.dll
Namespace
Cake.DocFx
Containing Type
DocFxMetadataAliases

Syntax

public static void DocFxMetadata(this ICakeContext context, IEnumerable<FilePath> files)

Examples

var files = GetFiles("./src/**/*.csproj");
DocFxMetadata(files);

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name Type Description
context ICakeContext The Cake context.
files IEnumerable<FilePath> The project or source files, or search patterns.

Return Value

Type Description
void