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
Merge base API in YAML files and toc files for the docfx.json
file in the current working
directory using the specified settings.
Syntax
public static void DocFxMerge(this ICakeContext context, DocFxMergeSettings settings)
Examples
DocFxMerge(new DocFxMergeSettings
{
TocMetadata = { "platform" },
WarningsAsErrors = true
});
Attributes
Type |
Description |
CakeMethodAliasAttribute |
|
CakeAliasCategoryAttribute |
|
Parameters
Name |
Type |
Description |
context |
ICakeContext |
The Cake context. |
settings |
DocFxMergeSettings |
The optional DocFx settings.
If no settings are passed default settings are used. |
Return Value