XmlDocCakeAddin.

XmlDocMarkdownGenerate(ICakeContext, string, string, 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, string inputPath, string outputPath, XmlDocMarkdownSettings settings = null)

Attributes

Type Description
CakeMethodAliasAttribute

Parameters

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

Return Value

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