xyDocGen 1.0.50

xyDocumentor

xyDocumentor is an open source CLI tool for generating API documentation from C# projects.
It supports Markdown, PDF, JSON , and HTML output.

Scans all C# files in the specified directory and below. Extracts all types and nested types, methods, properties, events, fields, etc. Collects the XML Comments from the project. Generates a tree and index to visualize the project structure. Each format is written into its own subfolder.

Usage example:

(Sample for easiest input to generate everything according to the standard settings) xydocgen =====>>>>> xydocgen --root [current working directory] --folder docs --subfolder api --exclude .git;bin;obj;node_modules;.vs;TestResults --format (all)

(Use dotnet at the start when installed locally) dotnet xydocgen --root . --out docs/api --exclude .git;bin;obj;node_modules;.vs;TestResults

(add this keyword to exclude non public) xydocgen --private

(Choose your output flavour) xydocgen --format [json/pdf/html/md]

(Another Sample) xydocgen --root X://User/TestPrograms/TestRoot--out TestFolder/TestSubFolder

(Output a list of commands, discard other commands written with it) xydocgen --help

Changes

• Only the chosen formats are generated
• Fixed the tree and index output on console
• Tree and index now get rendered before the other docs do

Planned features & improvements

• Change fontsizes
• Only put content list in pdf when there are nested types
• Outputting the remarks
• Upgrading the visual result of the outputs
• eventually add font and fontsize as parameters
• Add more details

Installation

Local:

dotnet new tool-manifest dotnet tool install --local xyDocGen --version 1.0.xx

Global:

dotnet tool install --global xyDocGen --version 1.0.xx

Update

Checking the Version of installed dotnet tools

dotnet list tool [--local/--global]

Updating the Version

dotnet tool update xydocgen [--local/--global]

Problems

PDF output needs ton be optimized!

Author

ThrashingLaggard https://github.com/ThrashingLaggard