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

Contains functionality related to extracting API metadata using DocFx.

Assembly

Cake.DocFx.dll

Namespace

Cake.DocFx

Base Types

graph BT Type-->Base0["Object"] Type["DocFxMetadataAliases"] class Type type-node

Syntax

public static class DocFxMetadataAliases

Type	Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Name	Value	Summary
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
DocFxMetadata(ICakeContext)	void	Extract API documentation using DocFx for the `docfx.json` file in the current working directory. static

Name	Value	Summary
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin