Version 2017.5.15.0

Release notes for version 2017.5.15.0.

Important Notes and Potential Breaking Changes

  • The help file builder Visual Studio package, standalone GUI, and all of the Sandcastle tools that run as MSBuild tasks have been updated to use the MSBuild 14.0 references. This was necessary to enable support for Universal Windows and the new .NETStandard format projects. If you are using the standalone GUI you may need to install the Microsoft Build Tools 2015.

    Any build components, plug-ins, etc. that reference the MSBuild assemblies may need to be updated to use the MSBuild 14.0 reference assemblies and then rebuilt.

  • Unfortunately, since I needed to upgrade to MSBuild 14.0 support, I had to drop support for the Visual Studio 2013 package as it does not work correctly with MSBuild 14.0. If you still need Visual Studio 2013 support, you will need to use the prior release. The standalone GUI from the current release may also be used.

  • A new cross-platform reflection data set file (CrossPlatform.reflection) was added. This is the preferred framework version setting to use for all .NETCore and .NETStandard assemblies and projects that you want to document. In addition, using this framework version will allow you to use any combination of .NETCore, .NETStandard, and .NETFramework Visual Studio projects or assemblies as documentation sources.

Documentation

  • Added a lineBreak element topic to the MAML Guide.

  • Revised the topic on how to install the MAML schemas in the MAML guide so that it shows how to use the help file builder copies of the files so that they do not need to be copied into the Visual Studio schema cache.

Sandcastle Tools

  • Fixed an exception in BuildAssembler caused by an ill-formed cref attribute value.

  • Fixed MRefBuilder so that it does not match a nested type to an incorrect file as its source code location under certain circumstances.

  • Updated MRefBuilder to output value tuple element names to support value tuple syntax in the syntax generators.

  • Added support for value tuple syntax in the C# and VB syntax generators.

  • Updated the Resolve Reference Links Component to try and resolve missing overload IDs to an equivalent non-overload method ID if the overload ID is not found.

  • Updated the Code Block Component so that it removes the trailing REM on regions imported from batch scripts.

  • Thanks to Robert van der Hulst for providing the syntax generator to support the X# language syntax ()

Sandcastle Help File Builder

Presentation Styles

See Also