-
Notifications
You must be signed in to change notification settings - Fork 365
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Misc fixes and documentation updates
General - Updated the MAML Snippets guided installer page so that you can select the My Documents folder if running under a different administrative account for installation. Sandcastle - Updated the BuildAssembler and MRefBuilder configuration files with explicit UTF-8 encoding to fix issues with component paths that contain certain foreign language characters. Fixes #172. - Updated the C#, VB.NET, and C++ syntax generators to output the value of constant fields. Closes #190. Sandcastle Help File Builder - Updated the VSPackage to install for all users rather than just the current user. Closes #155. Presentation Styles - 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. Closes #167.
- Loading branch information
1 parent
05f652a
commit 6458177
Showing
67 changed files
with
1,111 additions
and
489 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
97 changes: 97 additions & 0 deletions
97
Documentation/SandcastleBuilder/Content/VersionHistory/v2015.10.10.0.aml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
<?xml version="1.0" encoding="utf-8"?> | ||
<topic id="5a0130e2-a2ab-493c-a720-be43589e8b1c" revisionNumber="1"> | ||
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink"> | ||
<introduction> | ||
<autoOutline excludeRelatedTopics="true" lead="Release notes for version 2015.10.9.0." /> | ||
</introduction> | ||
|
||
<section address="BreakingChanges"> | ||
<title>Breaking Changes</title> | ||
<content> | ||
<para>The base <codeEntityReference qualifyHint="false">T:Sandcastle.Core.BuildAssembler.SyntaxGenerator.SyntaxGeneratorTemplate</codeEntityReference> | ||
class was modified to allow syntax generators to write out constant field values in the syntax section. The | ||
<codeInline>WriteTypeReference</codeInline> and <codeInline>WriteNormalTypeReference</codeInline> methods were | ||
added as virtual methods and a new <codeInline>WriteConstantValue</codeInline> 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 <codeInline>WriteFieldSyntax</codeInline> 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.</para> | ||
|
||
</content> | ||
</section> | ||
|
||
<section address="HelpFileBuilder"> | ||
<title>Help File Builder </title> | ||
<content> | ||
<list class="bullet"> | ||
<listItem> | ||
<para>Merged changes from RussKie that prevent flickering when resizing the standalone GUI's main | ||
window.</para> | ||
</listItem> | ||
|
||
<listItem> | ||
<para>Added support for Universal Windows application projects as documentation sources.</para> | ||
</listItem> | ||
|
||
<listItem> | ||
<para>Added a NuGet package for the .NET for Universal Windows framework data.</para> | ||
</listItem> | ||
|
||
<listItem> | ||
<para>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.</para> | ||
</listItem> | ||
|
||
<listItem> | ||
<para>Updated the Visual Studio package to install for all users rather than just the current user.</para> | ||
</listItem> | ||
|
||
</list> | ||
</content> | ||
</section> | ||
|
||
<section address="SandcastleTools"> | ||
<title>Sandcastle Tools</title> | ||
<content> | ||
<list class="bullet"> | ||
<listItem> | ||
<para>Updated the BuildAssembler and MRefBuilder configuration files with explicit UTF-8 encoding to | ||
fix issues with component paths that contain certain foreign language characters.</para> | ||
</listItem> | ||
|
||
<listItem> | ||
<para>Updated the C#, VB.NET, and C++ syntax generators to output the value of constant fields.</para> | ||
</listItem> | ||
|
||
</list> | ||
</content> | ||
</section> | ||
|
||
<section address="PresentationStyles"> | ||
<title>Presentation Styles</title> | ||
<content> | ||
<list class="bullet"> | ||
<listItem> | ||
<para>Merged changes from Rob Siklos to add support for the <codeInline>virtual</codeInline> and | ||
<codeInline>abstract</codeInline> language keywords on the <codeInline>see</codeInline> XML comments element.</para> | ||
</listItem> | ||
|
||
<listItem> | ||
<para>Based on a suggestion from Stoffelche, added support for the <codeInline>autoUpgrade</codeInline> | ||
and <codeInline>qualifyHint</codeInline> attributes on the <codeInline>see</codeInline> and | ||
<codeInline>seealso</codeInline> XML comments elements. This matches the behavior of the | ||
<codeInline>codeEntityReference</codeInline> MAML element with regard to qualifying member names and going to the | ||
overloads page.</para> | ||
</listItem> | ||
|
||
</list> | ||
</content> | ||
</section> | ||
|
||
<relatedTopics> | ||
<link xlink:href="078cc1c7-7995-431e-bf9c-8813becbe8df" /> | ||
</relatedTopics> | ||
|
||
</developerConceptualDocument> | ||
</topic> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file modified
BIN
-26.5 KB
(84%)
Documentation/SandcastleBuilder/media/ContentLayoutEditor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-19.2 KB
(59%)
Documentation/SandcastleBuilder/media/ResourceItemFileEditor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-64.4 KB
(33%)
Documentation/SandcastleBuilder/media/VSProjectPropsEditor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
Documentation/XMLCommentsGuide/Content/VersionHistory/v2015.10.10.0.aml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
<?xml version="1.0" encoding="utf-8"?> | ||
<topic id="380415aa-8aca-4abf-a1ae-bf8566c229f1" revisionNumber="1"> | ||
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink"> | ||
<introduction> | ||
<para>Release notes for version 2015.10.9.0.</para> | ||
</introduction> | ||
|
||
<section> | ||
<title>Changes in This Release</title> | ||
<content> | ||
|
||
<list class="bullet"> | ||
<listItem> | ||
<para>Merged changes from Rob Siklos about support for the <codeInline>virtual</codeInline> and | ||
<codeInline>abstract</codeInline> language keywords on the | ||
<link xlink:href="983fed56-321c-4daf-af16-e3169b28ffcd" /> XML comments element.</para> | ||
</listItem> | ||
<listItem> | ||
<para>Updated the <link xlink:href="983fed56-321c-4daf-af16-e3169b28ffcd" /> and | ||
<link xlink:href="16cdb957-a35b-4c17-bf5e-ea511b0218e3" /> topics to note support for the | ||
<codeInline>autoUpgrade</codeInline> and <codeInline>qualifyHint</codeInline> attributes. Based on a suggestion | ||
from Stoffelche.</para> | ||
</listItem> | ||
</list> | ||
|
||
</content> | ||
</section> | ||
|
||
<relatedTopics> | ||
<link xlink:href="0999CAAA-4992-4352-9ED2-965892040176" /> | ||
</relatedTopics> | ||
|
||
</developerConceptualDocument> | ||
</topic> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.