DotnetDocumentationGenerator 1.0.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet tool install --global DotnetDocumentationGenerator --version 1.0.0
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local DotnetDocumentationGenerator --version 1.0.0
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=DotnetDocumentationGenerator&version=1.0.0
nuke :add-package DotnetDocumentationGenerator --version 1.0.0

Dotnet Documentation Generator

A dotnet tool that generates project markdown documentation based on xml documentation <br>

In order for the documentation to be generated, the given functions must have xml documentation

///<summary>
///...

Installation

dotnet tool install --global DotnetDocumentationGenerator

Usage

  1. To generate documentation, remember to select the option Build -> Output -> Documentation File in the project you are interested in. This option will generate documentation in the form of an XML file.

XML Documenation generation

  1. Use command generate-doc --path "XML-FILE-PATH"

Example

generate-doc --path "C:\Users\kamil\OneDrive\Desktop\ConsoleFeatures\src\bin\Release\net7.0\ConsoleFeatures.xml"

Example md doc

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
1.0.0 214 2/7/2023