Fixed an issue with titles generated for overloaded operators

EWSoftware · Aug 15, 2022 · 64ea9fb · 64ea9fb
1 parent 6ec8b37
commit 64ea9fb
Show file tree

Hide file tree

Showing 14 changed files with 109 additions and 16 deletions.
diff --git a/Deployment/InstallerConfiguration.xml b/Deployment/InstallerConfiguration.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <configuration>
 	<!-- This indicates the tools version with which this installer is associated.-->
-	<tools version="2022.8.14.0" />
+	<tools version="2022.8.14.1" />
 
 	<!-- Define the installer pages.  Third-party build tool and component providers can add new pages that
 			 they have created to install their own products as well. -->

diff --git a/Documentation/SandcastleBuilder/CommonTokens.tokens b/Documentation/SandcastleBuilder/CommonTokens.tokens
@@ -6,6 +6,6 @@
     <ddue:linkUri>https://GitHub.com/EWSoftware/SHFB</ddue:linkUri>
     <ddue:linkTarget>_blank</ddue:linkTarget>
 </ddue:externalLink></item>
-  <item id="SandcastleVersion">v2022.8.14.0</item>
+  <item id="SandcastleVersion">v2022.8.14.1</item>
   <item id="VisualStudioMinVersion">Visual Studio 2017</item>
 </content>
diff --git a/Documentation/SandcastleBuilder/Content/License.aml b/Documentation/SandcastleBuilder/Content/License.aml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <topic id="24504fda-d3ef-4dd9-8335-6db8b25d00f2" revisionNumber="1">
-	<!-- Ignore Spelling: Maierhofer -->
+	<!-- Ignore Spelling: Maierhofer Fonticons Bulma Sagalaev -->
 	<developerConceptualDocument
     xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"
     xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -103,6 +103,29 @@ implied warranties of merchantability, fitness for a particular purpose and non-
 		<section address="Copyrights">
 			<title>Copyright Notices</title>
 			<content>
+				<para>Bulma is Copyright &#169; 2022 Jeremy Thomas, All Rights Reserved.  Code released under the MIT
+license (<externalLink>
+					<linkText>https://github.com/jgthms/bulma</linkText>
+					<linkAlternateText>Bulma</linkAlternateText>
+					<linkUri>https://github.com/jgthms/bulma</linkUri>
+					<linkTarget>_blank</linkTarget>
+				</externalLink>).</para>
+
+				<para>Font Awesome Free - License - <externalLink>
+					<linkText>https://fontawesome.com/license/free</linkText>
+					<linkAlternateText>Font Awesome</linkAlternateText>
+					<linkUri>https://fontawesome.com/license/free</linkUri>
+					<linkTarget>_blank</linkTarget>
+				</externalLink> (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License).  Copyright &#169; 2022
+Fonticons, Inc., All Rights Reserved.</para>
+
+				<para>Highlight.js is Copyright (c) 2006-2022 Ivan Sagalaev and other contributors (<externalLink>
+					<linkText>https://highlightjs.org/</linkText>
+					<linkAlternateText>highlight.js</linkAlternateText>
+					<linkUri>https://highlightjs.org/</linkUri>
+					<linkTarget>_blank</linkTarget>
+				</externalLink>) License: BSD-3-Clause.</para>
+
 				<para>The <externalLink>
 						<linkText>ICSharpCode.TextEditor</linkText>
 						<linkUri>https://github.com/icsharpcode</linkUri>

diff --git a/Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj b/Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj
@@ -35,7 +35,7 @@
     <FeedbackEMailAddress>Eric%40EWoodruff.us</FeedbackEMailAddress>
     <PresentationStyle>Default2022</PresentationStyle>
     <SyntaxFilters>Standard</SyntaxFilters>
-    <HelpFileVersion>2022.8.14.0</HelpFileVersion>
+    <HelpFileVersion>2022.8.14.1</HelpFileVersion>
     <ComponentConfigurations>
     </ComponentConfigurations>
     <DocumentationSources>

diff --git a/NuGet/SHFB.nuspec b/NuGet/SHFB.nuspec
@@ -6,6 +6,7 @@
 		<title>Sandcastle Help File Builder</title>
 		<authors>Eric Woodruff</authors>
 		<owners>Eric Woodruff</owners>
+		<!-- <readme>readme.md</readme> -->
 		<license type="expression">MS-PL</license>
 		<projectUrl>https://github.com/EWSoftware/SHFB</projectUrl>
 		<icon>SHFB.png</icon>

diff --git a/NuGet/readme.md b/NuGet/readme.md
@@ -0,0 +1,48 @@
+# Sandcastle Help File Builder
+
+This package allows you to deploy the Sandcastle Help File Builder tools inside of a project to build help files
+without installing the tools manually such as on a build server.  The following limitations apply:
+
+- You must install one or more of the Reflection Data Set packages based on which platform types you need:
+
+  `.NET`, `.NETCore`, `.NETFramework`, `.NETMicroFramework`, `.NETPortable`, `Silverlight`, `WindowsPhone`,
+  `WindowsPhoneApp`, and/or `UniversalWindows`.
+
+  If multiple versions are available for any given reflection data set package, download the latest version as
+  it will cover all prior versions as well.
+
+- Set the project's ComponentPath property to the .\packages folder so that the project can find the reflection
+  data files and any other third-party build components, plug-ins, presentation styles, etc. deployed as NuGet
+  packages.
+
+- Only the website, MS Help Viewer, Open XML, and markdown help file formats are supported unconditionally as
+  there are no external tool dependencies for them.
+
+- To build Help 1 output, the required help compiler tools and components must be installed separately.  Help file
+  builds using that formats will fail if those components are not installed.
+
+- Any third-party build components, plug-ins, presentation styles, etc. not deployed as NuGet packages must be
+  included within your project and must be placed within the project folder so that they can be found.
+
+- The `SHFBROOT` environment variable does not need to be defined.  However, the help file project must contain a
+  conditional property that defines the relative path to the SHFB tools folder within the main `PropertyGroup`
+  element.
+
+  Example:
+  ``` XML
+  <PropertyGroup>
+    <!-- NOTE: Update the version number in the path (YYYY.M.D.R) to match the package version -->
+    <SHFBROOT Condition=" '$(SHFBROOT)' == '' ">$(MSBuildThisFileDirectory)..\packages\EWSoftware.SHFB.YYYY.M.D.R\Tools\</SHFBROOT>
+
+    ... other SHFB project properties ...
+
+  </PropertyGroup>
+  ```
+
+- No standalone GUI or Visual Studio support is provided for managing the help project and none of the non-essential
+  tools or help files are included in this package in order to keep its size down to the bare minimum.  If wanted,
+  those items must be downloaded and installed from the GitHub project site using the guided installer:
+  [https://GitHub.com/EWSoftware/SHFB](https://GitHub.com/EWSoftware/SHFB)
+
+See the [XCOPY/NuGet Build Server Deployment](http://EWSoftware.github.io/SHFB/html/50ad2c8c-5004-4b4c-a77f-97b8c403c9f2.htm)
+help topic for more details.
diff --git a/SHFB/Source/PresentationStyles/Default2022/Default2022Transformation.cs b/SHFB/Source/PresentationStyles/Default2022/Default2022Transformation.cs
@@ -839,7 +839,17 @@ private void RenderHeaderMetadata()
                     title = new XText(this.ApiMember.Name);
                 }
                 else
-                    title = this.ApiTopicTocTitleSimple();
+                {
+                    // Use simple titles except for operators which need the parameter details to differentiate
+                    // them in many cases.
+                    if(this.ApiMember.ApiTopicSubgroup == ApiMemberGroup.Overload ||
+                      this.ApiMember.ApiSubSubgroup != ApiMemberGroup.Operator)
+                    {
+                        title = this.ApiTopicTocTitleSimple();
+                    }
+                    else
+                        title = this.ApiTopicTitle(false, true);
+                }
 
                 this.CurrentElement.Add(new XElement("meta", new XAttribute("name", "Title"),
                     new XElement("includeAttribute",

diff --git a/SHFB/Source/SandcastleBuilderUtils/Properties/AssemblyInfoShared.cs b/SHFB/Source/SandcastleBuilderUtils/Properties/AssemblyInfoShared.cs
@@ -2,7 +2,7 @@
 // System  : Sandcastle Help File Builder
 // File    : AssemblyInfoShared.cs
 // Author  : Eric Woodruff  (Eric@EWoodruff.us)
-// Updated : 08/14/2022
+// Updated : 08/15/2022
 // Note    : Copyright 2006-2022, Eric Woodruff, All rights reserved
 //
 // Sandcastle Help File Builder common assembly attributes.
@@ -90,13 +90,13 @@ internal static partial class AssemblyInfo
     //
     // This is used to set the assembly file version.  This will change with each new release.  MSIs only
     // support a Major value between 0 and 255 so we drop the century from the year on this one.
-    public const string FileVersion = "22.8.14.0";
+    public const string FileVersion = "22.8.14.1";
 
     // Common product version
     //
     // This may contain additional text to indicate Alpha or Beta states.  The version number will always match
     // the file version above but includes the century on the year.
-    public const string ProductVersion = "2022.8.14.0";
+    public const string ProductVersion = "2022.8.14.1";
 
     // Assembly copyright information
     public const string Copyright = "Copyright \xA9 2006-2022, Eric Woodruff, All Rights Reserved";

diff --git a/SHFB/Source/SandcastleCore/PresentationStyle/Transformation/TopicTransformationCore.cs b/SHFB/Source/SandcastleCore/PresentationStyle/Transformation/TopicTransformationCore.cs
@@ -2,7 +2,7 @@
 // System  : Sandcastle Tools - Sandcastle Tools Core Class Library
 // File    : TopicTransformationCore.cs
 // Author  : Eric Woodruff  (Eric@EWoodruff.us)
-// Updated : 08/07/2022
+// Updated : 08/15/2022
 // Note    : Copyright 2022, Eric Woodruff, All rights reserved
 //
 // This file contains the abstract base class that is used to define the settings and common functionality for a
@@ -1287,7 +1287,8 @@ protected virtual XNode ApiTopicTitle(bool qualifyMembers, bool plainText)
                 titleParam.Add(this.ApiTopicShortNameDecorated());
 
             // Only show parameters for operators and overloaded members
-            if(this.ApiMember.ApiSubSubgroup == ApiMemberGroup.Operator &&
+            if(this.ApiMember.ApiTopicSubgroup != ApiMemberGroup.Overload &&
+              this.ApiMember.ApiSubSubgroup == ApiMemberGroup.Operator &&
               (this.ApiMember.Name.Equals("Explicit", StringComparison.Ordinal) ||
                this.ApiMember.Name.Equals("Implicit", StringComparison.Ordinal)))
             {

diff --git a/SHFB/Source/SandcastleCore/Properties/AssemblyInfoShared.cs b/SHFB/Source/SandcastleCore/Properties/AssemblyInfoShared.cs
@@ -1,7 +1,7 @@
 //===============================================================================================================
 // System  : Sandcastle Tools
 // File    : AssemblyInfoShared.cs
-// Updated : 08/14/2022
+// Updated : 08/15/2022
 // Note    : Copyright 2006-2022, Microsoft Corporation, All rights reserved
 //
 // Sandcastle tools common assembly attributes.
@@ -73,13 +73,13 @@ internal static partial class AssemblyInfo
     //
     // This is used to set the assembly file version.  This will change with each new release.  MSIs only
     // support a Major value between 0 and 255 so we drop the century from the year on this one.
-    public const string FileVersion = "22.8.14.0";
+    public const string FileVersion = "22.8.14.1";
 
     // Common product version
     //
     // This may contain additional text to indicate Alpha or Beta states.  The version number will always match
     // the file version above but includes the century on the year.
-    public const string ProductVersion = "2022.8.14.0";
+    public const string ProductVersion = "2022.8.14.1";
 
     // Assembly copyright information
     public const string Copyright = "Copyright \xA9 2006-2022, Microsoft Corporation, All Rights Reserved.\r\n" +

diff --git a/SHFB/Source/SandcastleInstaller/InstallerConfiguration.xml b/SHFB/Source/SandcastleInstaller/InstallerConfiguration.xml
@@ -4,7 +4,7 @@
 	<pathOffset location="..\..\..\..\..\Deployment" />
 
 	<!-- This indicates the tools version with which this installer is associated.-->
-	<tools version="2022.8.14.0" />
+	<tools version="2022.8.14.1" />
 
 	<!-- Define the installer pages.  Third-party build tool and component providers can add new pages that
 			 they have created to install their own products as well. -->

diff --git a/SHFB/Source/VSIX_VS2017/source.extension.vsixmanifest b/SHFB/Source/VSIX_VS2017/source.extension.vsixmanifest
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
 	<Metadata>
-		<Identity Id="c997d569-ee8e-4947-a46f-9a0717ce39a0" Version="2022.8.14.0" Language="en-US" Publisher="EWSoftware" />
+		<Identity Id="c997d569-ee8e-4947-a46f-9a0717ce39a0" Version="2022.8.14.1" Language="en-US" Publisher="EWSoftware" />
 		<DisplayName>SHFB (VS2017 and VS2019)</DisplayName>
 		<Description xml:space="preserve">Visual Studio integration for the Sandcastle Help File Builder.</Description>
 		<MoreInfo>https://ewsoftware.github.io/SHFB/html/bd1ddb51-1c4f-434f-bb1a-ce2135d3a909.htm</MoreInfo>

diff --git a/SHFB/Source/VSIX_VS2022/source.extension.vsixmanifest b/SHFB/Source/VSIX_VS2022/source.extension.vsixmanifest
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
 	<Metadata>
-		<Identity Id="SHFB.A8C96335-DAF7-4D30-89E2-B004400E4525" Version="2022.8.14.0" Language="en-US" Publisher="EWSoftware" />
+		<Identity Id="SHFB.A8C96335-DAF7-4D30-89E2-B004400E4525" Version="2022.8.14.1" Language="en-US" Publisher="EWSoftware" />
 		<DisplayName>SHFB (VS2022 and Later)</DisplayName>
 		<Description xml:space="preserve">Visual Studio integration for the Sandcastle Help File Builder.</Description>
 		<MoreInfo>https://ewsoftware.github.io/SHFB/html/bd1ddb51-1c4f-434f-bb1a-ce2135d3a909.htm</MoreInfo>

diff --git a/TestCaseProject/IndexTocBugs/OpOverloadTocBug.cs b/TestCaseProject/IndexTocBugs/OpOverloadTocBug.cs
@@ -217,6 +217,16 @@ public struct Test1
             return "Test";
         }
 
+        /// <summary>
+        /// Implicit conversion overload
+        /// </summary>
+        /// <param name="test1">Test</param>
+        /// <returns>Integer</returns>
+        public static implicit operator Int32(Test1 test1)
+        {
+            return 0;
+        }
+
         /// <summary>
         /// Explicit conversion
         /// </summary>