DocFxMetadataAliases Class

Summary

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

Syntax

public static class DocFxMetadataAliases

Attributes

Type Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Methods

Name Value Summary
DocFxMetadata(ICakeContext) void
Extract API documentation using DocFx for the docfx.json file in the current working directory.
static
DocFxMetadata(ICakeContext, DocFxMetadataSettings) void
Extract API documentation using DocFx, with the specified settings.
static
DocFxMetadata(ICakeContext, FilePath) void
Extract API documentation using DocFx for a specific docfx.json file.
static
DocFxMetadata(ICakeContext, IEnumerable<FilePath>) void
Extract API documentation using DocFx, with the specified project/source files or search patterns.
static

Extension Methods

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