XmlDocCakeAddin.

XmlDocMarkdownGenerate(ICakeContext, FilePath, DirectoryPath, XmlDocMarkdownSettings) Method

Summary

Generates Markdown from .NET XML documentation comments.
Assembly
Cake.XmlDocMarkdown.dll
Namespace
Cake.XmlDocMarkdown
Containing Type
XmlDocCakeAddin

Syntax

public static XmlDocMarkdownResult XmlDocMarkdownGenerate(this ICakeContext context, FilePath inputPath, DirectoryPath outputPath, XmlDocMarkdownSettings settings = null)

Attributes

Type Description
CakeMethodAliasAttribute

Parameters

Name Type Description
context ICakeContext The Cake context.
inputPath FilePath The input assembly.
outputPath DirectoryPath The output directory.
settings XmlDocMarkdownSettings The settings.

Return Value

Type Description
XmlDocMarkdownResult The names of files that were added, changed, or removed.