Generates markdown documentation files from assembly XML documentation comments.
public static class MarkdownCodeDocGenerator
void Run(Assembly assemblyToCodeDoc, DirectoryInfo outputPath = null, bool runOnNonWindows = False)Summary: Generates markdown documentation files for all public types in the specified assembly.
Parameters:
assemblyToCodeDoc- The assembly to document.
outputPath- The output directory for generated markdown files. If not specified, defaults to a CodeDoc folder relative to the assembly location.
runOnNonWindows- When (default), the generator silently no-ops on non-Windows platforms. This preserves the historical behavior because some CI environments place the generated .xml doc files in a different location on Linux/macOS. Set to to force the generator to run cross-platform — useful in test environments where the caller has confirmed the XML file is reachable.Code usage:
MarkdownCodeDocGenerator.Run(Assembly.GetAssembly(typeof(OneTypeFromTheAssemblyToDocument)));Code example:
MarkdownCodeDocGenerator.Run(Assembly.GetAssembly(typeof(LocalizedDescriptionAttribute)));