Zastai.Build.ApiReference.Library 3.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package Zastai.Build.ApiReference.Library --version 3.0.0                

                    
                

            
NuGet\Install-Package Zastai.Build.ApiReference.Library -Version 3.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Zastai.Build.ApiReference.Library" Version="3.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Zastai.Build.ApiReference.Library --version 3.0.0                

                    
                

            
#r "nuget: Zastai.Build.ApiReference.Library, 3.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Zastai.Build.ApiReference.Library as a Cake Addin
#addin nuget:?package=Zastai.Build.ApiReference.Library&version=3.0.0

// Install Zastai.Build.ApiReference.Library as a Cake Tool
#tool nuget:?package=Zastai.Build.ApiReference.Library&version=3.0.0

Zastai.Build.ApiReference.Library Build Status NuGet Package Version

This library provides a means of formatting an assembly's public API as either plain C# or Markdown with C# code blocks.

Main Use

The main usage pattern is:

  • Create an instance of CodeFormatter; currently, two implementations are provided: CSharpFormatter and CSharpMarkdownFormatter.
  • Configure the processing, using methods like EnableCharEnums() and ExcludeCustomAttributes(), and properties like IncludeInternals.
  • Call the FormatPublicApi() method, which returns a stream of API reference source lines, which you are then free to send wherever you like.

Note that formatters are not currently thread-safe; only one FormatPublicApi() call should be running at any one time. Note that this includes the streaming processing triggered by enumerating its result, so if you want to do multiple calls before processing the results, you will need to either use multiple instances, or use something like ToList() to make sure all processing is completed before the next call.

Implementing Other Output Languages

In and of itself, this can be achieved by creating a new subclass of CodeFormatter and implementing the various abstract methods.

However, it's currently written with C# in mind, so the API may not be 100% suitable if trying to do a different language.

Release Notes

These are available on GitHub.

Credits

Package icon created by DinosoftLabs - FlatIcon.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 was computed.  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 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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
3.0.0 80 12/31/2024