Files

T

copilot-swe-agent[bot] 7b1c16bc47 Update XmlDocGenerator README with NuGet package usage

Co-authored-by: omegaleo <5655201+omegaleo@users.noreply.github.com>

2026-02-11 22:56:27 +00:00

1.6 KiB

Raw Blame History

OmegaLeo.HelperLib.XmlDocGenerator

Automatic XML documentation generator for DocumentationAttribute. This MSBuild package automatically generates XML documentation comments from your DocumentationAttribute declarations, making them visible in IDE IntelliSense and tooltips.

Installation

Automatic (Recommended)

Simply install the OmegaLeo.HelperLib.Documentation package:

dotnet add package OmegaLeo.HelperLib.Documentation

The XmlDocGenerator is automatically included as a dependency and will work out of the box!

Manual

If you want to use the XmlDocGenerator standalone:

dotnet add package OmegaLeo.HelperLib.XmlDocGenerator

How It Works

MSBuild Integration: The package includes MSBuild targets that are automatically imported
Build-Time Generation: Runs after CoreCompile to analyze your compiled assembly
Attribute Reading: Uses reflection to read DocumentationAttribute instances
XML Generation: Creates/augments XML documentation files
IntelliSense Ready: IDEs automatically pick up the generated XML

Features

✅ Automatic: Zero configuration needed
✅ Build-time: No runtime overhead
✅ Non-breaking: Works alongside existing XML comments
✅ Cross-platform: Works on Windows, Linux, macOS
✅ Multi-targeting: Supports all .NET target frameworks
✅ IDE Support: Works with Visual Studio, Rider, VS Code

Configuration

By default, XML generation is enabled. To disable it:

<PropertyGroup>
  <GenerateXmlDocFromDocumentationAttribute>false</GenerateXmlDocFromDocumentationAttribute>
</PropertyGroup>

License

AGPL-3.0-only

1.6 KiB Raw Blame History