TomsToolbox.Settings.Documentation.Abstractions 1.1.0

.NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher. 
dotnet add package TomsToolbox.Settings.Documentation.Abstractions --version 1.1.0
                    


                    

                
NuGet\Install-Package TomsToolbox.Settings.Documentation.Abstractions -Version 1.1.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="TomsToolbox.Settings.Documentation.Abstractions" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="TomsToolbox.Settings.Documentation.Abstractions" Version="1.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="TomsToolbox.Settings.Documentation.Abstractions" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add TomsToolbox.Settings.Documentation.Abstractions --version 1.1.0
                    


                    

                
#r "nuget: TomsToolbox.Settings.Documentation.Abstractions, 1.1.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. 
#:package TomsToolbox.Settings.Documentation.Abstractions@1.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=TomsToolbox.Settings.Documentation.Abstractions&version=1.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=TomsToolbox.Settings.Documentation.Abstractions&version=1.1.0
                    


                            Install as a Cake Tool

TomsToolbox.Settings.Documentation.Abstractions

Provides attributes for documenting and configuring .NET application settings classes.

Overview

This package contains a set of attributes that help document configuration settings in .NET applications. These attributes work with configuration documentation generators to produce clear, structured documentation of your application's configuration options.

Attributes

SettingsSectionAttribute

Marks a class as settings class, and optionally specifies the configuration section name associated with the settings class.

[SettingsSection("MyApp")]
public class MyAppSettings
{
    public string ApiUrl { get; set; }
}

SettingsIgnoreAttribute

Excludes a class or property from settings documentation.

public class Settings
{
    public string DocumentedProperty { get; set; }
    
    [SettingsIgnore]
    public string InternalProperty { get; set; }
}

SettingsSecretAttribute

Marks properties containing sensitive data (passwords, API keys, etc.) to be masked in documentation.

public class DatabaseSettings
{
    public string Server { get; set; }
    
    [SettingsSecret]
    public string Password { get; set; }
}

SettingsAddOptionsInvocatorAttribute

Identifies methods that register configuration options with the dependency injection container.

[SettingsAddOptionsInvocator]
public static void CustomAddOptions<T>(IServiceCollection services)
{
    services.AddOptions<T>().BindConfiguration(typeof(T).Name);
}

Requirements

  • .NET Standard 2.1 or higher
  • TomsToolbox.Settings.Documentation.Builder - Runtime library for generating documentation
  • TomsToolbox.Settings.Documentation.Analyzer - Roslyn analyzer for compile-time validation

License

MIT License

Part of the TomsToolbox library suite.

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 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.  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.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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.

  • .NETStandard 2.1

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on TomsToolbox.Settings.Documentation.Abstractions:

Package Downloads
TomsToolbox.Settings.Documentation.Builder

Automatically generate comprehensive documentation for your .NET application configuration settings. Keep your 'appsettings.json' files documented, validated, and always up-to-date with JSON schemas, Markdown, and HTML documentation.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.0 179 5/21/2026
1.0.0 177 1/12/2026
1.0.0-beta9 148 1/9/2026
1.0.0-beta8 147 1/9/2026
1.0.0-beta7 153 1/9/2026
1.0.0-beta6 154 1/9/2026
1.0.0-beta5 153 1/9/2026
1.0.0-beta4 156 1/9/2026
1.0.0-beta3 149 1/6/2026
1.0.0-beta2 152 1/6/2026
1.0.0-beta10 150 1/10/2026
1.0.0-beta1 152 1/5/2026