v0.5.180
New Features
- API Reference: Add multi-assembly support
- Command Line Help: Order parameters in the "Usage" section
- Add .NET 6 support
- Add .NET 7 Support
- Remove support for older versions of .NET and Visual Studio
Bug Fixes
- Command Line Help: Disable syntax-highlighting for a command's "Usage" CommandUsageSection
- Make sorting in output consistent across different frameworks
- API Reference: Fix rendering of default values of value type and decimal parameters
Breaking Changes
- The mddocs:apireference:assemblyPath setting was renamed to mddocs:apireference:assemblyPaths and its type was changed from a string to an array of strings
- The '--assembly' command line parameter of the apireference command has been renamed to '--assemblies'
- The MdDocs CLI tool now requires at least .NET 6
- The MdDocs.MSBuild package is now requires at least the .NET 6 SDK (when running on MSBuild Core) or Visual Studio 2022 (when running on "Desktop MSBuild")
Details
API Reference: Add multi-assembly support
- Breaking Change: The mddocs:apireference:assemblyPath setting was renamed to mddocs:apireference:assemblyPaths and its type was changed from a string to an array of strings
- Breaking Change: The '--assembly' command line parameter of the apireference command has been renamed to '--assemblies'
Add support for rendering API reference documentation for multiple assemblies.
When multiple assemblies are specified, documentation is generated for all types from all assemblies.
The file layout of the output is unchanged and is based on a symbol's name and namespace.
Specifying multiple input assemblies is supported in the MdDocs command line tool but not in the MdDocs MSBuild task which continues to generate documentation for the current project's output assembly.
Command Line Help: Order parameters in the "Usage" section
In a command's "Usage" section, order the parameters.
Positional parameters are ordered by their position, followed by named parameters (required parameters first, then ordered by name) and switch parameters (ordered by name)
- Commit:
e51f605
Add .NET 6 support
Add support for running MdDocs on .NET 6
Add .NET 7 Support
Add support for running the MdDocs .NET CLI tool on .NET 7 and add test to ensure MdDocs.MSBuild works on the .NET 7 SDK
Remove support for older versions of .NET and Visual Studio
- Breaking Change: The MdDocs CLI tool now requires at least .NET 6
- Breaking Change: The MdDocs.MSBuild package is now requires at least the .NET 6 SDK (when running on MSBuild Core) or Visual Studio 2022 (when running on "Desktop MSBuild")
In the MdDocs CLI tool, remove support for .NET Core 3.1 and .NET 5 which have both reached their end-of-life.
For the MdDocs MSBuild package, remove support for running on the .NET Core 3.1 and .NET 5 SDKs (in the case of MSBuild Core) and versions of Visual Studio older than Visual Studio 2022 (in the case of "Desktop MSBuild")
Command Line Help: Disable syntax-highlighting for a command's "Usage" CommandUsageSection
Add Markdown info string "txt" to usage sections to prevent (wrong) syntax highlighting from being applied to it.
- Commit:
14c5ae5
Make sorting in output consistent across different frameworks
.NET 5 changed the default sorting behavior for strings causing the output of MdDocs to be different when running on net5.0 vs. running on earlier .NET Core versions or .NET Framework.
Make sorting consistent by explicitly using "Ordinal" comparisons for all sort operations.
- See Also: https://docs.microsoft.com/en-us/dotnet/standard/base-types/string-comparison-net-5-plus
- Commit:
4846d07
API Reference: Fix rendering of default values of value type and decimal parameters
Fixes rendering of value type and decimal parameters in method default values
Thanks @madelson
