DocFx aliases

Cake.DocFx addin

Contains functionality related to extracting API metadata using DocFx.

Build

DocFx()
Alias from Cake.DocFx addin
Obsolete. Use Cake.DocFx.DocFxBuildAliases.DocFxBuild(Cake.Core.ICakeContext) instead.
DocFx(DocFxSettings)
Alias from Cake.DocFx addin
Obsolete. Use Cake.DocFx.DocFxBuildAliases.DocFxBuild(Cake.Core.ICakeContext,Cake.DocFx.Build.DocFxBuildSettings) instead.
DocFx(FilePath)
Alias from Cake.DocFx addin
Obsolete. Use Cake.DocFx.DocFxBuildAliases.DocFxBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath) instead.
DocFx(FilePath, DocFxSettings)
Alias from Cake.DocFx addin
Obsolete. Use Cake.DocFx.DocFxBuildAliases.DocFxBuild(Cake.Core.ICakeContext,Cake.Core.IO.FilePath,Cake.DocFx.Build.DocFxBuildSettings) instead.
DocFxBuild()
Alias from Cake.DocFx addin
Generate client-only website combining API in YAML files and conceptual files for the docfx.json file in the current working directory.
DocFxBuild(DocFxBuildSettings)
Alias from Cake.DocFx addin
Generate client-only website combining API in YAML files and conceptual files for the docfx.json file in the current working directory using the specified settings.
DocFxBuild(FilePath)
Alias from Cake.DocFx addin
Generate client-only website combining API in YAML files and conceptual files for a specific docfx.json file.
DocFxBuild(FilePath, DocFxBuildSettings)
Alias from Cake.DocFx addin
Generate client-only website combining API in YAML files and conceptual files for a specific docfx.json file using the specified settings.

Init

DocFxInit()
Alias from Cake.DocFx addin
Generate an initial docfx.json file.
DocFxInit(DocFxInitSettings)
Alias from Cake.DocFx addin
Generate an initial docfx.json file, with the specified settings.

Merge

DocFxMerge()
Alias from Cake.DocFx addin
Merge base API in YAML files and toc files for the docfx.json file in the current working directory.
DocFxMerge(DocFxMergeSettings)
Alias from Cake.DocFx addin
Merge base API in YAML files and toc files for the docfx.json file in the current working directory using the specified settings.
DocFxMerge(FilePath)
Alias from Cake.DocFx addin
Merge base API in YAML files and toc files for a specific docfx.json file.
DocFxMerge(FilePath, DocFxMergeSettings)
Alias from Cake.DocFx addin
Merge base API in YAML files and toc files for a specific docfx.json file using the specified settings.

Metadata

DocFxMetadata()
Alias from Cake.DocFx addin
Extract API documentation using DocFx for the docfx.json file in the current working directory.
DocFxMetadata(DocFxMetadataSettings)
Alias from Cake.DocFx addin
Extract API documentation using DocFx, with the specified settings.
DocFxMetadata(FilePath)
Alias from Cake.DocFx addin
Extract API documentation using DocFx for a specific docfx.json file.
DocFxMetadata(IEnumerable<FilePath>)
Alias from Cake.DocFx addin
Extract API documentation using DocFx, with the specified project/source files or search patterns.

Pdf

DocFxPdf()
Alias from Cake.DocFx addin
Generates a PDF document for the docfx.json file in the current working directory.
DocFxPdf(DocFxPdfSettings)
Alias from Cake.DocFx addin
Generates a PDF document for the docfx.json file in the current working directory using the specified settings.
DocFxPdf(FilePath)
Alias from Cake.DocFx addin
Generates a PDF document for a specific docfx.json file.
DocFxPdf(FilePath, DocFxPdfSettings)
Alias from Cake.DocFx addin
Generates a PDF document for a specific docfx.json file using the specified settings.

Serve

DocFxServe()
Alias from Cake.DocFx addin
Serve a website from the current directory.
DocFxServe(DirectoryPath)
Alias from Cake.DocFx addin
Serve a website from the specified directory.
DocFxServe(DirectoryPath, DocFxServeSettings)
Alias from Cake.DocFx addin
Serve a website from the specified directory with the specified settings.
DocFxServeStart()
Alias from Cake.DocFx addin
Start serving a website from the current directory.
DocFxServeStart(DirectoryPath)
Alias from Cake.DocFx addin
Start serving a website from the specified directory.
DocFxServeStart(DirectoryPath, DocFxServeSettings)
Alias from Cake.DocFx addin
Start serving a website from the specified directory with the specified settings.