Method SaveResults

Namespace

Docfx.ResultSnippets

Assembly

Docfx.ResultSnippets.dll

SaveResults<T>(T, string, string, string, bool, string, string)

Saves the result to an example file that can be included in documentation

public static void SaveResults<T>(this T result, string folder = "__examples__", string extension = "md", string partName = "", bool replaceExisting = true, string sourceFilePath = "", string memberName = "")

Parameters

result T

some result to save

folder string

folder to save it under, default is __examples__

extension string

extension to use for the example file, default is md

partName string

optional part name

replaceExisting bool

flag to indicate that existing example files are to be replaced, default is true

sourceFilePath string

source file path of the calling code

memberName string

member name of the calling code

Type Parameters

T

some T to ToString and save

Remarks

The generated file name format is `{sourceFilePath}.{memberName}.({partName}.).{extension}`

This is saved under the `folder`, __examples__ by default relative to the executing code in `sourceFilePath`