DocFxMergeAliases Class

Summary

Contains functionality related to merging base API files using DocFx.
Assembly
Cake.DocFx.dll
Namespace
Cake.DocFx
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["DocFxMergeAliases"] class Type type-node

Syntax

public static class DocFxMergeAliases

Attributes

Type Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Methods

Name Value Summary
DocFxMerge(ICakeContext) void
Merge base API in YAML files and toc files for the docfx.json file in the current working directory.
static
DocFxMerge(ICakeContext, DocFxMergeSettings) void
Merge base API in YAML files and toc files for the docfx.json file in the current working directory using the specified settings.
static
DocFxMerge(ICakeContext, FilePath) void
Merge base API in YAML files and toc files for a specific docfx.json file.
static
DocFxMerge(ICakeContext, FilePath, DocFxMergeSettings) void
Merge base API in YAML files and toc files for a specific docfx.json file using the specified settings.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin