Skip to content

Latest commit

 

History

History
38 lines (31 loc) · 1.05 KB

Atc.CodeDocumentation.Markdown.md

File metadata and controls

38 lines (31 loc) · 1.05 KB

Atc.CodeDocumentation.Markdown


MarkdownCodeDocGenerator

MarkdownCodeDocGenerator.

public static class MarkdownCodeDocGenerator

Static Methods

Run

void Run(Assembly assemblyToCodeDoc, DirectoryInfo outputPath = null)

Summary: Runs on the specified assembly to document the code in markdown files.

Parameters:
     assemblyToCodeDoc  -  The assembly to code document.
     outputPath  -  The output path.

Code usage:

MarkdownCodeDocGenerator.Run(Assembly.GetAssembly(typeof(OneTypeFromTheAssemblyToDocument)));

Code example:

MarkdownCodeDocGenerator.Run(Assembly.GetAssembly(typeof(LocalizedDescriptionAttribute)));

Generated by MarkdownCodeDoc version 1.2