Zastai.Build.ApiReference 1.1.2

<Sdk Name="Zastai.Build.ApiReference" Version="1.1.2" />
For projects that support Sdk, copy this XML node into the project file to reference the package.

Zastai.Build.ApiReference Build Status NuGet Package Version

Extends an MSBuild project to produce an API reference source for each output assembly.

This source is not intended to be compilable; rather the intent is for it to be kept under source control, so that any changes to public API are easy to detect and track.

Configuration - Properties

The following properties can be set in the project to affect the behaviour:


The format to use for the API Reference source.

Supported Values: C# (or cs or csharp) for C#, and C#-MarkDown (or variations using cs, csharp instead of C# and/or md instead of MarkDown) for MarkDown-with-C#.


The directories to search for the dependencies of the output assemblies (separated by semicolons).

If not specified, it will use the list of referenced assemblies as determined by the build.


The directory where the API Reference source is created.

Defaults to $(TargetDir).


The extension used for the API Reference source.

Defaults to .cs when the format is C#, and when the format is MarkDown-with-C#.


The full path of the API Reference source.

Defaults to $(ApiReferenceOutputDir)$(TargetName)$(ApiReferenceOutputExt).

Note: when setting this yourself in a project file, you cannot rely on any of the other defaulted properties (like ApiReferenceOutputExt, for example), because that defaulting happens after the project file is read. To be able to do that, set it in Directory.Build.targets (docs).


Determines whether the directory part of ApiReferenceOutputPath will be created as part of the processing.

Defaults to false.


Determines whether API Reference sources will be generated for each assembly.

Defaults to true.


The program used to run the generator under Mono.

Defaults to mono --runtime=v4.0.30319.


The program used to run the generator under .NET Core.

Defaults to dotnet.


Determines whether the output files are registered in @(FileWrites).

Defaults to false.

Configuration - Which Attributes to Include

The choice of which attributes to consider part of the public API is based on two item groups:

Property Description
ApiReferenceIncludeAttribute Attributes to include. If not specified, all attributes are included, unless excluded via @(ApiReferenceExcludeAttribute).
ApiReferenceExcludeAttribute Attributes to exclude. Applies to attributes included (whether explicitly or implicitly) via @(ApiReferenceIncludeAttribute).

In both cases, names match against the full internal name of the attribute type (like Namespace.GenericTypeName`2/NestedAttribute). Attributes handled as part of syntax generation (like System.ParamArrayAttribute and System.Runtime.CompilerServices.ExtensionAttribute) are never included.

Release Notes

These are available on GitHub.


Package icon created by DinosoftLabs - FlatIcon.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.2 141 1/24/2023
1.1.1 261 8/31/2022
1.1.0 291 6/13/2022
1.0.0 298 5/2/2022