XmlDocs

Package	NuGet.org	Azure Artifacts
Grynwald.XmlDocs
Grynwald.XmlDocs.MarkdownRenderer

Overview

A library for parsing C# XML Documentation files and a utility library to convert XML documentation comments to Markdown.

This repository hosts the following packages that provide functionality for processing XML documentation comments.

Grynwald.XmlDocs is a library for parsing XML documentation comments into a .NET object model.
- For details, please refer to the package README
Grynwald.XmlDocs.MarkdownRenderer is provides a converter from XML documentation comments to Markdown
- It is based on Grynwald.XmlDocs and Markdown Generator
- Note: The package can only convert the contents of the XML documentation file. It is not a full .NET documentation generator.
- For details, please refer to the package README

Prerelease builds are available on Azure Artifacts
Release versions are available on NuGet.org:
- Grynwald.XmlDocs
- Grynwald.XmlDocs.MarkdownRenderer

Building from source requires the .NET 7 SDK (version 6.0.100 as specified in global.json) and uses Cake for the build.

To execute the default task, run

.\build.ps1

This will build the project, run all tests and pack the NuGet package.

XmlDocs was made possible through a number of libraries (aside from .NET itself):

The version of this project is automatically derived from git and the information in version.json using Nerdbank.GitVersioning:

The master branch always contains the latest version. Packages produced from master are always marked as pre-release versions (using the -pre suffix).
Stable versions are built from release branches. Builds from release branches will have no -pre suffix.
Builds from any other branch will have both the -pre prerelease tag and the git commit hash included in the version string.

To create a new release branch use the nbgv tool:

dotnet tool restore
dotnet tool run nbgv -- prepare-release