Skip to content

Latest commit

 

History

History
53 lines (31 loc) · 2.39 KB

README.md

File metadata and controls

53 lines (31 loc) · 2.39 KB
Raw

DendroDocs.Tool

Nuget Coverage Status

DendroDocs.Tool is the successor to the Living 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.

Features

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

Shared Code

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

Prerequisites

  • .NET 8.0 SDK or newer.

Installation

Install DendroDocs.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

Output

The output of DendroDocs.Tool is a comprehensive JSON file that conforms to the schema defined in the DendroDocs 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.

The DendroDocs Ecosystem

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

Contributing

Contributions are welcome! Please feel free to create issues or pull requests.

License

This project is licensed under the MIT License.