Grynwald.XmlDocs
1.0.6
See the version list below for details.
dotnet add package Grynwald.XmlDocs --version 1.0.6
NuGet\Install-Package Grynwald.XmlDocs -Version 1.0.6
<PackageReference Include="Grynwald.XmlDocs" Version="1.0.6" />
paket add Grynwald.XmlDocs --version 1.0.6
#r "nuget: Grynwald.XmlDocs, 1.0.6"
// Install Grynwald.XmlDocs as a Cake Addin #addin nuget:?package=Grynwald.XmlDocs&version=1.0.6 // Install Grynwald.XmlDocs as a Cake Tool #tool nuget:?package=Grynwald.XmlDocs&version=1.0.6
Grynwald.XmlDocs
Table of Contents
Overview
C# source code can have structured comments to provide inline API documentation. These comments are saved by the compiler as an XML documentation file.
The Grynwald.XmlDocs
package provides a library for parsing these comments into a .NET object model.
Usage
To parse an XML documentation file, first reference the Grynwald.XmlDocs
package in your project.
Load the documentation file using the DocumentationFile
class:
using Grynwald.XmlDocs;
// Load XML documentation file
var documentationFile = DocumentationFile.FromFile("./MyAssembly.xml");
Alternatively, you can parse individual elements directly, e.g. to parse a <member />
node from the documentation file, use
using Grynwald.XmlDocs;
var memberXml = """
<member name="T:ExampleProject.ExampleClass">
<summary>
XML documentation file example
</summary>
</member>
"""
var member = MemberElement.FromXml(memberXml);
To process the documentation file, the library provides support for the Visitor pattern.
To create a visitor, either implement IDocumentationVisitor
directly or derive from the default implementation DocumentationVisitor
and override the Visit()
method for the documentation element you want to process.
License
Grynwald.XmlDocs.MarkdownRenderer is licensed under the MIT License.
For details see https://github.com/ap0llo/xmldocs/blob/master/LICENSE
Product | Versions 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 is compatible. 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. |
-
net6.0
- No dependencies.
-
net7.0
- No dependencies.
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Grynwald.XmlDocs:
Package | Downloads |
---|---|
Grynwald.XmlDocs.MarkdownRenderer
A library for converting .NET XML documentation files to Markdown. |
GitHub repositories
This package is not used by any popular GitHub repositories.