MarkdownApiExtensions.

GenerateMarkdownApi(ICakeContext, string, string, ITheme) Method

Summary

Generate Markdown Api Documentation based on C# dll and Xml Comments

Syntax

public static void GenerateMarkdownApi(this ICakeContext context, string searchPath, string outputPath, ITheme theme = null)

Attributes

Type Description
CakeMethodAliasAttribute

Parameters

Name Type Description
context ICakeContext The ICakeContext
searchPath string The path to search for dlls and xml comments
outputPath string The path to output the markdown files
theme ITheme Optional theme used to define the format of the markdown files

Return Value

Type Description
void