Version 2015.10.10.0

Release notes for version 2015.10.10.0.

Breaking Changes

The base SyntaxGeneratorTemplate class was modified to allow syntax generators to write out constant field values in the syntax section. The WriteTypeReference and WriteNormalTypeReference methods were added as virtual methods and a new WriteConstantValue method was added. If you have created your own syntax generator classes, you may need to modify the two above noted methods in your own classes by either removing them if they match the base functionality or changing them from private methods to protected override methods. You can also add support to the WriteFieldSyntax method to output the value for constant fields. Regardless of whether or not you used the above methods, you will need to rebuild your syntax generators using the latest Sandcastle Help File Builder assemblies.

Help File Builder

  • Merged changes from RussKie that prevent flickering when resizing the standalone GUI's main window.

  • Added support for Universal Windows application projects as documentation sources.

  • Added a NuGet package for the .NET for Universal Windows framework data.

  • Added Visual Studio theme support to all help file builder package tool windows and editors and updated the icons so that they look better when used with the dark theme.

  • Updated the Visual Studio package to install for all users rather than just the current user.

Sandcastle Tools

  • Updated the BuildAssembler and MRefBuilder configuration files with explicit UTF-8 encoding to fix issues with component paths that contain certain foreign language characters.

  • Updated the C#, VB.NET, and C++ syntax generators to output the value of constant fields.

Presentation Styles

  • Merged changes from Rob Siklos to add support for the sealed and NotInheritable language keywords on the see XML comments element.

  • Based on a suggestion from Stoffelche, added support for the autoUpgrade and qualifyHint attributes on the see and seealso XML comments elements. This matches the behavior of the codeEntityReference MAML element with regard to qualifying member names and going to the overloads page.

See Also

Other Resources