Skip to content

v0.4.163
Compare
Choose a tag to compare
@ap0llo ap0llo released this 02 Sep 19:43
v0.4.163
3924daa

Known Issues

New Features

Bug Fixes

Breaking Changes

Details

Update dependencies to the latest versions

Update dependencies to their respective latest stable version

Add configuration file support

Breaking Change: The MSBuild integration no longer defines a default value for the output path. To set the output path, specify it either in the configuration file or set the MSBuild property ApiReferenceDocumentationOutputPath respectively CommandLineDocumentationOutputPath.

Add support for specifying settings in a configuration file that can be used by both the MdDocs CLI as well as the MdDocs MSBuild targets.

The configuration system integrates both the (optional) configuration file and commandline parameters (MdDocs CLI) / MSBuild Properties (MdDocs MSBuild targets).

Include notice in output files to indicate files are auto-generated

Add a comment at the beginning of each generated markdown document to indicate the file was auto-generated by a tool.

Add setting to disable the comment to configuration.

API Reference: Include assembly version in generated API Reference documentation

By default, include the assembly version in the generated API reference documentation on pages for types and type members. Additionally, the documentation for type members will now also include the namespace and assembly name of the declaring type.

The inclusion of the assembly version can be disabled in the configuration file or using the '--no-version' command line switch of the 'apireference' command (analogous to the 'commandlinehelp' command).

Command Line Help: Add accepted values for commandline parameters of type bool?

When a commandline parameter property is of type bool?, automatically determine accepted values to be "true" and "false"

Add JSON Schema for the configuration file.

Add a JSON Schema for the configuration file to provide auto-completion support when editing the file in editors that support JSON Schema (e.g. Visual Studio Code).

Add support for templates

  • Breaking Change: The command line parameters 'markdown-preset' and 'no-version' have been removed. Use corresponding settings in configuration file instead.
  • Breaking Change: The MSBuild property 'MdDocsMarkdownPreset' is no longer supported. Use corresponding setting in configuration file instead.

Implement support for having different output templates. By default, the output produced will be the same as previous versions, because the existing implementation is included as the default template.

Because some options (like "Markdown Preset") are specific to the template being used, these settings have been moved to the default template's configuration section in the configuration file.
Additionally, the corresponding commandline parameters (of the .NET CLI tool version of MdDocs) and MSBuild properties (for the MSBuild-integrated version) have been removed because it would lead to confusion if some settings for one of the templates would be exposed as "top-level" parameter.

Command Line Help: Fix incompatibility with CommandLineParser 2.8.0

CommandLineParser 2.8 introduced an additional constructor parameter for VerbAttribute which cause loading command line help to fail. Adjust loading of commands to accommodate for that change.
The fix is backwards compatible and should also work with earlier versions of the CommandLineParser library.

API Reference: Use correct casing for boolean literals in generated C# definitions

In generated definitions that contain bool literals, emit the literals as "true" and "false" instead of "True" and "False".

Command Line Help: Fix loading of commands and parameters when the option class is a nested type

Load types recursively to discover all types annotated with [Verb] and/or [Option] attributes instead of just loading top-level types.

Assets 4
Loading