|
| 1 | +<?xml version="1.0" encoding="utf-8"?> |
| 2 | +<topic id="a4050331-ee69-42e2-8c84-2f3a9a890b13" revisionNumber="1"> |
| 3 | + <developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink"> |
| 4 | + <introduction> |
| 5 | + <para>Release notes for version 2024.2.18.0. See the prior version release notes for information on the |
| 6 | +breaking changes made to the presentation styles implementation.</para> |
| 7 | + </introduction> |
| 8 | + |
| 9 | + <section address="BreakingChanges"> |
| 10 | + <title>Breaking Changes in This Release</title> |
| 11 | + <content> |
| 12 | + <alert class="important"> |
| 13 | + <para>If you have created custom build components, syntax generators, plug-ins, or presentation styles, |
| 14 | +you will need to rebuild them against the latest release of the help file builder NuGet packages.</para> |
| 15 | + </alert> |
| 16 | + |
| 17 | + <list class="bullet"> |
| 18 | + <listItem> |
| 19 | + <para>The Microsoft Learn cross-reference resolver service used to generate links to the online .NET |
| 20 | +Framework API topics is being shut down. As such, this release replaces the resolver service with a code-based |
| 21 | +implementation that no longer requires an external service nor a persistent cache to store previously resolved |
| 22 | +URLs to online topics. The removal of the persistent cache also allows it to work with more recent versions of |
| 23 | +the <localUri>dotnet build</localUri> tool that use a version of .NET that disables binary serialization.</para> |
| 24 | + </listItem> |
| 25 | + |
| 26 | + <listItem> |
| 27 | + <para>Added <codeInline>HasFooterContent</codeInline> and <codeInline>HasWebsiteAdContent</codeInline> |
| 28 | +properties to <codeInline>TopicTransformationCore</codeInline> to allow Build Assembler to indicate whether or |
| 29 | +not the current project contains those items. If not, the transformation is free to remove any related elements |
| 30 | +to preserve page formatting and layout.</para> |
| 31 | + </listItem> |
| 32 | + |
| 33 | + <listItem> |
| 34 | + <para>A couple of new transformation arguments were added as noted below.</para> |
| 35 | + </listItem> |
| 36 | + |
| 37 | + </list> |
| 38 | + |
| 39 | + </content> |
| 40 | + </section> |
| 41 | + |
| 42 | + <section> |
| 43 | + <title>Build Tools</title> |
| 44 | + <content> |
| 45 | + <list class="bullet"> |
| 46 | + <listItem> |
| 47 | + <para>Fixed an issue with the MRefBuilder name matching.</para> |
| 48 | + </listItem> |
| 49 | + |
| 50 | + <listItem> |
| 51 | + <para>Added support for .NET 7 static interface members.</para> |
| 52 | + </listItem> |
| 53 | + |
| 54 | + <listItem> |
| 55 | + <para>Fixed the syntax for finalizers in the C# and managed C++ syntax generators.</para> |
| 56 | + </listItem> |
| 57 | + |
| 58 | + <listItem> |
| 59 | + <para>Private protected nested types are now excluded unless including internals.</para> |
| 60 | + </listItem> |
| 61 | + </list> |
| 62 | + |
| 63 | + </content> |
| 64 | + </section> |
| 65 | + |
| 66 | + <section> |
| 67 | + <title>Sandcastle Help File Builder</title> |
| 68 | + <content> |
| 69 | + <list class="bullet"> |
| 70 | + <listItem> |
| 71 | + <para>Regenerated the .NET reflection data set to include .NET 8.0 members. Also regenerated the |
| 72 | +.NET Framework data set to correct a few minor issues with implemented member information.</para> |
| 73 | + </listItem> |
| 74 | + |
| 75 | + <listItem> |
| 76 | + <para>Made BE0060 an error instead of a warning since the vast majority of the time the problem does |
| 77 | +cause invalid Help 1 (CHM) file output even if the build succeeds.</para> |
| 78 | + </listItem> |
| 79 | + |
| 80 | + <listItem> |
| 81 | + <para>Disabled Go To Definition on <codeInline>name</codeInline> attribute values.</para> |
| 82 | + </listItem> |
| 83 | + </list> |
| 84 | + </content> |
| 85 | + </section> |
| 86 | + |
| 87 | + <section> |
| 88 | + <title>Presentation Styles</title> |
| 89 | + <content> |
| 90 | + <list class="bullet"> |
| 91 | + <listItem> |
| 92 | + <para>Added a <codeInline>ShowParametersOnAllMethods</codeInline> transformation argument to all |
| 93 | +presentation styles to allow showing parameters on all methods, not just overloads, on member list pages.</para> |
| 94 | + </listItem> |
| 95 | + |
| 96 | + <listItem> |
| 97 | + <para>Added an <codeInline>AlwaysShowTopLevelAutoOutline</codeInline> transformation argument to the |
| 98 | +Default 2022 presentation style to allow always showing the top-level auto-outlines regardless of the display |
| 99 | +size.</para> |
| 100 | + </listItem> |
| 101 | + |
| 102 | + <listItem> |
| 103 | + <para>Fixed all presentation styles so that they render a syntax section even if all syntax |
| 104 | +generators are disabled so that parameters, returns, and implements info is included in the topic.</para> |
| 105 | + </listItem> |
| 106 | + |
| 107 | + <listItem> |
| 108 | + <para>Added '+' to the list of version number separators so that Git commit IDs can be removed from |
| 109 | +<codeInline>AssemblyInformationalVersion</codeInline> attribute values by specifying a fixed number of version |
| 110 | +number parts to include.</para> |
| 111 | + </listItem> |
| 112 | + |
| 113 | + <listItem> |
| 114 | + <para>Fixed the auto-outline element so that it hides the default lead-in text as well.</para> |
| 115 | + </listItem> |
| 116 | + </list> |
| 117 | + </content> |
| 118 | + </section> |
| 119 | + |
| 120 | + <relatedTopics> |
| 121 | + <link xlink:href="078cc1c7-7995-431e-bf9c-8813becbe8df" /> |
| 122 | + </relatedTopics> |
| 123 | + |
| 124 | + </developerConceptualDocument> |
| 125 | +</topic> |
0 commit comments