This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see
Cake.DocFx.
Summary
Extract API documentation using DocFx, with the specified settings.
Syntax
public static void DocFxMetadata(this ICakeContext context, DocFxMetadataSettings settings)
Examples
DocFxMetadata(new DocFxMetadataSettings()
{
OutputPath = "./artifacts/docs"
});
DocFxMetadata(new DocFxMetadataSettings()
{
OutputPath = "./artifacts/docs",
Projects = GetFiles("./src/**/*.csproj")
});
Attributes
| Type |
Description |
| CakeMethodAliasAttribute |
|
| CakeAliasCategoryAttribute |
|
Parameters
| Name |
Type |
Description |
| context |
ICakeContext |
The Cake context. |
| settings |
DocFxMetadataSettings |
The DocFx settings. |
Return Value
