-
Notifications
You must be signed in to change notification settings - Fork 367
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Sandcastle Tools - Fixed the URL resolver so that the web client connection uses TLS 1.2 which is now required by the server hosting the service. Fixes #762. Sandcastle Help File Builder - Fixed the build engine so that it sets the TargetFramework property in the documentation source project when multi-targeting is being used. This allows other properties that use it to be resolved correctly. Fixes #759. - Fixed documentation assembly determination by checking the TargetExt property and using it as the target assembly extension when the output type is Exe. This solves a problem with web SDK projects that output a native code host runtime assembly alongside the actual DLL. Fixes #752.
- Loading branch information
1 parent
af98869
commit e0de8b2
Showing
22 changed files
with
193 additions
and
254 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
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
81 changes: 81 additions & 0 deletions
81
Documentation/SandcastleBuilder/Content/VersionHistory/v2019.11.17.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,81 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <topic id="f8d393f6-a081-43ad-9a84-e8d379f2de56" revisionNumber="1"> | ||
| <developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink"> | ||
| <!-- Ignore Spelling: Englert Exe --> | ||
| <introduction> | ||
| <autoOutline excludeRelatedTopics="true" lead="Release notes for version 2019.11.17.0." /> | ||
|
|
||
| <alert class="note"> | ||
| <para>This will be the last release that supports Visual Studio 2015. The next release will be updated | ||
| to use .NET 4.7 and Visual Studio 2017 or later.</para> | ||
| </alert> | ||
| </introduction> | ||
|
|
||
| <section address="SandcastleTools"> | ||
| <title>Sandcastle Tools</title> | ||
| <content> | ||
|
|
||
| <list class="bullet"> | ||
| <listItem> | ||
| <para>Updated the Generate Inherited Documentation tool to issue a warning | ||
| (<link xlink:href="69791faf-a420-4fc9-9dba-10d3f3f817a1">GID0010</link>) if it finds the deprecated | ||
| <codeInline>select</codeInline> attribute on the <codeInline>inheritdoc</codeInline> element.</para> | ||
| </listItem> | ||
|
|
||
| <listItem> | ||
| <para>Fixed the URL resolver so that the web client connection uses TLS 1.2 which is now required by | ||
| the server hosting the service.</para> | ||
| </listItem> | ||
| </list> | ||
|
|
||
| </content> | ||
| </section> | ||
|
|
||
| <section address="SHFB"> | ||
| <title>Sandcastle Help File Builder</title> | ||
| <content> | ||
|
|
||
| <list class="bullet"> | ||
| <listItem> | ||
| <para>Merged changes into the default project template from Tom Englert to allow the help file | ||
| builder NuGet packages to be referenced and restored within the help file project itself.</para> | ||
| </listItem> | ||
|
|
||
| <listItem> | ||
| <para>Fixed the build engine so that it sets the <codeInline>TargetFramework</codeInline> property in | ||
| the documentation source project when multi-targeting is being used. This allows other properties that use it to | ||
| be resolved correctly.</para> | ||
| </listItem> | ||
|
|
||
| <listItem> | ||
| <para>Fixed documentation assembly determination by checking the <codeInline>TargetExt</codeInline> | ||
| property and using it as the target assembly extension when the output type is "Exe". This solves a problem with | ||
| web SDK projects that output a native code host runtime assembly alongside the actual DLL.</para> | ||
| </listItem> | ||
|
|
||
| </list> | ||
|
|
||
| </content> | ||
| </section> | ||
|
|
||
| <section address="Docs"> | ||
| <title>Documentation</title> | ||
| <content> | ||
|
|
||
| <list class="bullet"> | ||
| <listItem> | ||
| <para>Updated the XML comments guide <codeInline>inheritdoc</codeInline> documentation to note that | ||
| the <codeInline>select</codeInline> attribute has been deprecated in favor of the <codeInline>path</codeInline> | ||
| attribute to be consistent with upcoming support for the element in Visual Studio 2019's IntelliSense.</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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
| // System : Sandcastle Help File Builder Components | ||
| // File : MicrosoftDocsXRefServiceResolver.cs | ||
| // Author : Eric Woodruff ([email protected]) | ||
| // Updated : 08/16/2019 | ||
| // Updated : 11/15/2019 | ||
| // Note : Copyright 2019, Eric Woodruff, All rights reserved | ||
| // Compiler: Microsoft Visual C# | ||
| // | ||
|
|
@@ -73,6 +73,11 @@ public sealed class MicrosoftDocsXRefServiceResolver : IMemberIdUrlResolver | |
| /// <overloads>There are two overloads for the constructor</overloads> | ||
| public MicrosoftDocsXRefServiceResolver() | ||
| { | ||
| // .NET 4.5 doesn't use TLS 1.2 by default so we have to manually tell it to use it or the web client | ||
| // connections will fail. This can be removed once we upgrade to .NET 4.6.2 or later. | ||
| if((ServicePointManager.SecurityProtocol & SecurityProtocolType.Tls12) != SecurityProtocolType.Tls12) | ||
| ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12; | ||
|
|
||
| client = new WebClient(); | ||
|
|
||
| this.CrossReferenceUrlFormat = "https://xref.docs.microsoft.com/query?uid={0}"; | ||
|
|
||
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
2 changes: 1 addition & 1 deletion
2
SHFB/Source/SandcastleBuilderPackage/source.extension.vsixmanifest
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,8 +2,8 @@ | |
| // System : Sandcastle Help File Builder Plug-Ins | ||
| // File : AjaxDocPlugIn.cs | ||
| // Author : Eric Woodruff ([email protected]) | ||
| // Updated : 05/25/2015 | ||
| // Note : Copyright 2007-2015, Eric Woodruff, All rights reserved | ||
| // Updated : 11/15/2019 | ||
| // Note : Copyright 2007-2019, Eric Woodruff, All rights reserved | ||
| // Compiler: Microsoft Visual C# | ||
| // | ||
| // This file contains a plug-in designed to generate XML comments and reflection file information for Atlas | ||
|
|
@@ -285,6 +285,11 @@ public void Execute(SandcastleBuilder.Utils.BuildComponent.ExecutionContext cont | |
| // Allow Before step plug-ins to run | ||
| builder.ExecuteBeforeStepPlugIns(); | ||
|
|
||
| // .NET 4.5 doesn't use TLS 1.2 by default so we have to manually tell it to use it or the web client | ||
| // connections will fail. This can be removed once we upgrade to .NET 4.6.2 or later. | ||
| if((ServicePointManager.SecurityProtocol & SecurityProtocolType.Tls12) != SecurityProtocolType.Tls12) | ||
| ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12; | ||
|
|
||
| // Download the files | ||
| using(WebClient webClient = new WebClient()) | ||
| { | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -2,8 +2,8 @@ | |
| // System : Sandcastle Help File Builder Plug-Ins | ||
| // File : DeploymentPlugIn.cs | ||
| // Author : Eric Woodruff ([email protected]) | ||
| // Updated : 05/03/2015 | ||
| // Note : Copyright 2007-2015, Eric Woodruff, All rights reserved | ||
| // Updated : 11/15/2019 | ||
| // Note : Copyright 2007-2019, Eric Woodruff, All rights reserved | ||
| // Compiler: Microsoft Visual C# | ||
| // | ||
| // This file contains a plug-in that can be used to deploy the resulting help file output to a location other | ||
|
|
@@ -264,6 +264,12 @@ private void DeployOutput(Collection<string> files, DeploymentLocation location) | |
| rootPath = target.LocalPath; | ||
| else | ||
| { | ||
| // .NET 4.5 doesn't use TLS 1.2 by default so we have to manually tell it to use it or the | ||
| // web client connections will fail. This can be removed once we upgrade to .NET 4.6.2 or | ||
| // later. | ||
| if((ServicePointManager.SecurityProtocol & SecurityProtocolType.Tls12) != SecurityProtocolType.Tls12) | ||
| ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12; | ||
|
|
||
| // FTP, HTTP, etc. | ||
| rootPath = target.ToString(); | ||
| webClient = new WebClient(); | ||
|
|
||
Oops, something went wrong.