Zastai.Build.ApiReference.Tool
3.0.0
dotnet tool install --global Zastai.Build.ApiReference.Tool --version 3.0.0
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local Zastai.Build.ApiReference.Tool --version 3.0.0
#tool dotnet:?package=Zastai.Build.ApiReference.Tool&version=3.0.0
nuke :add-package Zastai.Build.ApiReference.Tool --version 3.0.0
Zastai.Build.ApiReference.Tool 
This is a simple command-line tool to enable generating an API reference source for a .NET assembly.
Installation
Local to a Solution
To install the tool as part of a specific solution, run
dotnet tool install Zastai.Build.ApiReference.Tool --create-manifest-if-needed
from the solution folder. This will create a tool manifest
(.config/dotnet-tools.json) if needed and make the tool available
using either dotnet tool run dotnet-api-reference or
dotnet dotnet-api-reference.
When committed, the tool manifest allows using dotnet tool restore to
(re)install any tools the solution has configured.
Machine Wide
To install it globally, for use anywhere on the machine, run
dotnet tool install -g Zastai.Build.ApiReference.Tool
This will enable running the tool using just dotnet-api-reference.
Usage
dotnet-api-reference ASSEMBLY OUTPUT-FILE [OPTIONS]
Options
-ea ATTRIBUTE-TYPE-NAME
Exclude a particular attribute by name. Simple shell wildcards (* and
?) are supported.
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.
-eh ENUM-HANDLING
Activate specific enum handling (one or more flags, comma-separated).
| Flag | Description |
|---|---|
binary |
use binary literals for [Flags] enum values |
char |
try to use character literals (enums based on ushort only) |
hex |
use hexadecimal literals for [Flags] enum values |
-f FORMAT
Specifies the format for the API reference source.
FORMAT Value |
Description |
|---|---|
csharp / cs |
plain C# syntax |
csharp-markdown / cs-md |
Markdown with C# code blocks |
If not specified, plain C# will be used.
-ia ATTRIBUTE-TYPE-NAME
Include a particular attribute by name. Simple shell wildcards (* and
?) are supported. If this is specified, all attributes not explicitly
included will be excluded by default.
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.
-r DEPENDENCY-DIR
Adds DEPENDENCY-DIR to the set of locations that will be searched
when resolving the main assembly's references.
-v VISIBILITY
Determines which items are included in the API reference source. Can be
either public, to only include public API, or internal, to also
include elements marked as internal or private protected.
If not specified, only public API is included.
Release Notes
These are available on GitHub.
Credits
Package icon created by DinosoftLabs - FlatIcon.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. 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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. |
This package has no dependencies.
| Version | Downloads | Last updated |
|---|---|---|
| 3.0.0 | 93 | 12/31/2024 |