Repository files navigation

DendroDocs.Tool is the successor to theLiving Documentation Analyzer, providing a solution for analyzing dotnet projects and generating detailed JSON outputs.This tool is a key component of the DendroDocs ecosystem, designed to bridge the gap between evolving code and up-to-date documentation.

A command-line tool that analyzes dotnet projects or solutions and produces a JSON file that follows the schema defined in theDendroDocs Schema repository.

DendroDocs.Tool uses the shared library from theDendroDocs.Shared repository, ensuring reusability across different parts of the DendroDocs dotnet ecosystem.

• .NET 8.0 SDK or newer.

InstallDendroDocs.Tool as a dotnet global tool:

dotnet tool install --global DendroDocs.Tool

Example usage:

dendrodocs-analyze --solution G:\DendroDocs\dotnet-shared-lib\DendroDocs.Shared.sln --output shared.json --pretty --verbose --exclude G:\DendroDocs\dotnet-shared-lib\build\_build.csproj

The output ofDendroDocs.Tool is a comprehensive JSON file that conforms to the schema defined in theDendroDocs Schema.This JSON file provides a representation of your source code, which can be used to generate various types of documentation or integrate with other tools in your development pipeline.

DendroDocs.Tool is part of the broader DendroDocs ecosystem.ExploreDendroDocs to find more tools, libraries, and documentation resources that help you bridge the gap between your code and its documentation.

Contributions are welcome! Please feel free to createissues orpull requests.

This project is licensed under the MIT License.