Skip to content

Commit 64ea9fb

Browse files
EWSoftwareEWSoftware
committed
Fixed an issue with titles generated for overloaded operators
1 parent 6ec8b37 commit 64ea9fb

File tree

14 files changed

+109
-16
lines changed

14 files changed

+109
-16
lines changed

‎Deployment/InstallerConfiguration.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="utf-8" ?>
22
<configuration>
33
<!-- This indicates the tools version with which this installer is associated.-->
4-
<tools version="2022.8.14.0" />
4+
<tools version="2022.8.14.1" />
55

66
<!-- Define the installer pages. Third-party build tool and component providers can add new pages that
77
they have created to install their own products as well. -->

‎Documentation/SandcastleBuilder/CommonTokens.tokens‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
<ddue:linkUri>https://GitHub.com/EWSoftware/SHFB</ddue:linkUri>
77
<ddue:linkTarget>_blank</ddue:linkTarget>
88
</ddue:externalLink></item>
9-
<item id="SandcastleVersion">v2022.8.14.0</item>
9+
<item id="SandcastleVersion">v2022.8.14.1</item>
1010
<item id="VisualStudioMinVersion">Visual Studio 2017</item>
1111
</content>

‎Documentation/SandcastleBuilder/Content/License.aml‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<topic id="24504fda-d3ef-4dd9-8335-6db8b25d00f2" revisionNumber="1">
3-
<!-- Ignore Spelling: Maierhofer -->
3+
<!-- Ignore Spelling: Maierhofer Fonticons Bulma Sagalaev -->
44
<developerConceptualDocument
55
xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"
66
xmlns:xlink="http://www.w3.org/1999/xlink">
@@ -103,6 +103,29 @@ implied warranties of merchantability, fitness for a particular purpose and non-
103103
<section address="Copyrights">
104104
<title>Copyright Notices</title>
105105
<content>
106+
<para>Bulma is Copyright &#169; 2022 Jeremy Thomas, All Rights Reserved. Code released under the MIT
107+
license (<externalLink>
108+
<linkText>https://github.com/jgthms/bulma</linkText>
109+
<linkAlternateText>Bulma</linkAlternateText>
110+
<linkUri>https://github.com/jgthms/bulma</linkUri>
111+
<linkTarget>_blank</linkTarget>
112+
</externalLink>).</para>
113+
114+
<para>Font Awesome Free - License - <externalLink>
115+
<linkText>https://fontawesome.com/license/free</linkText>
116+
<linkAlternateText>Font Awesome</linkAlternateText>
117+
<linkUri>https://fontawesome.com/license/free</linkUri>
118+
<linkTarget>_blank</linkTarget>
119+
</externalLink> (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License). Copyright &#169; 2022
120+
Fonticons, Inc., All Rights Reserved.</para>
121+
122+
<para>Highlight.js is Copyright (c) 2006-2022 Ivan Sagalaev and other contributors (<externalLink>
123+
<linkText>https://highlightjs.org/</linkText>
124+
<linkAlternateText>highlight.js</linkAlternateText>
125+
<linkUri>https://highlightjs.org/</linkUri>
126+
<linkTarget>_blank</linkTarget>
127+
</externalLink>) License: BSD-3-Clause.</para>
128+
106129
<para>The <externalLink>
107130
<linkText>ICSharpCode.TextEditor</linkText>
108131
<linkUri>https://github.com/icsharpcode</linkUri>

‎Documentation/SandcastleBuilder/SandcastleBuilder.shfbproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<FeedbackEMailAddress>Eric%40EWoodruff.us</FeedbackEMailAddress>
3636
<PresentationStyle>Default2022</PresentationStyle>
3737
<SyntaxFilters>Standard</SyntaxFilters>
38-
<HelpFileVersion>2022.8.14.0</HelpFileVersion>
38+
<HelpFileVersion>2022.8.14.1</HelpFileVersion>
3939
<ComponentConfigurations>
4040
</ComponentConfigurations>
4141
<DocumentationSources>

‎NuGet/SHFB.nuspec‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
<title>Sandcastle Help File Builder</title>
77
<authors>Eric Woodruff</authors>
88
<owners>Eric Woodruff</owners>
9+
<!-- <readme>readme.md</readme> -->
910
<license type="expression">MS-PL</license>
1011
<projectUrl>https://github.com/EWSoftware/SHFB</projectUrl>
1112
<icon>SHFB.png</icon>

‎NuGet/readme.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Sandcastle Help File Builder
2+
3+
This package allows you to deploy the Sandcastle Help File Builder tools inside of a project to build help files
4+
without installing the tools manually such as on a build server. The following limitations apply:
5+
6+
- You must install one or more of the Reflection Data Set packages based on which platform types you need:
7+
8+
`.NET`, `.NETCore`, `.NETFramework`, `.NETMicroFramework`, `.NETPortable`, `Silverlight`, `WindowsPhone`,
9+
`WindowsPhoneApp`, and/or `UniversalWindows`.
10+
11+
If multiple versions are available for any given reflection data set package, download the latest version as
12+
it will cover all prior versions as well.
13+
14+
- Set the project's ComponentPath property to the .\packages folder so that the project can find the reflection
15+
data files and any other third-party build components, plug-ins, presentation styles, etc. deployed as NuGet
16+
packages.
17+
18+
- Only the website, MS Help Viewer, Open XML, and markdown help file formats are supported unconditionally as
19+
there are no external tool dependencies for them.
20+
21+
- To build Help 1 output, the required help compiler tools and components must be installed separately. Help file
22+
builds using that formats will fail if those components are not installed.
23+
24+
- Any third-party build components, plug-ins, presentation styles, etc. not deployed as NuGet packages must be
25+
included within your project and must be placed within the project folder so that they can be found.
26+
27+
- The `SHFBROOT` environment variable does not need to be defined. However, the help file project must contain a
28+
conditional property that defines the relative path to the SHFB tools folder within the main `PropertyGroup`
29+
element.
30+
31+
Example:
32+
``` XML
33+
<PropertyGroup>
34+
<!-- NOTE: Update the version number in the path (YYYY.M.D.R) to match the package version -->
35+
<SHFBROOT Condition=" '$(SHFBROOT)' == '' ">$(MSBuildThisFileDirectory)..\packages\EWSoftware.SHFB.YYYY.M.D.R\Tools\</SHFBROOT>
36+
37+
... other SHFB project properties ...
38+
39+
</PropertyGroup>
40+
```
41+
42+
- No standalone GUI or Visual Studio support is provided for managing the help project and none of the non-essential
43+
tools or help files are included in this package in order to keep its size down to the bare minimum. If wanted,
44+
those items must be downloaded and installed from the GitHub project site using the guided installer:
45+
[https://GitHub.com/EWSoftware/SHFB](https://GitHub.com/EWSoftware/SHFB)
46+
47+
See the [XCOPY/NuGet Build Server Deployment](http://EWSoftware.github.io/SHFB/html/50ad2c8c-5004-4b4c-a77f-97b8c403c9f2.htm)
48+
help topic for more details.

‎SHFB/Source/PresentationStyles/Default2022/Default2022Transformation.cs‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -839,7 +839,17 @@ private void RenderHeaderMetadata()
839839
title = new XText(this.ApiMember.Name);
840840
}
841841
else
842-
title = this.ApiTopicTocTitleSimple();
842+
{
843+
// Use simple titles except for operators which need the parameter details to differentiate
844+
// them in many cases.
845+
if(this.ApiMember.ApiTopicSubgroup == ApiMemberGroup.Overload ||
846+
this.ApiMember.ApiSubSubgroup != ApiMemberGroup.Operator)
847+
{
848+
title = this.ApiTopicTocTitleSimple();
849+
}
850+
else
851+
title = this.ApiTopicTitle(false, true);
852+
}
843853

844854
this.CurrentElement.Add(new XElement("meta", new XAttribute("name", "Title"),
845855
new XElement("includeAttribute",

‎SHFB/Source/SandcastleBuilderUtils/Properties/AssemblyInfoShared.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// System : Sandcastle Help File Builder
33
// File : AssemblyInfoShared.cs
44
// Author : Eric Woodruff ([email protected])
5-
// Updated : 08/14/2022
5+
// Updated : 08/15/2022
66
// Note : Copyright 2006-2022, Eric Woodruff, All rights reserved
77
//
88
// Sandcastle Help File Builder common assembly attributes.
@@ -90,13 +90,13 @@ internal static partial class AssemblyInfo
9090
//
9191
// This is used to set the assembly file version. This will change with each new release. MSIs only
9292
// support a Major value between 0 and 255 so we drop the century from the year on this one.
93-
public const string FileVersion = "22.8.14.0";
93+
public const string FileVersion = "22.8.14.1";
9494

9595
// Common product version
9696
//
9797
// This may contain additional text to indicate Alpha or Beta states. The version number will always match
9898
// the file version above but includes the century on the year.
99-
public const string ProductVersion = "2022.8.14.0";
99+
public const string ProductVersion = "2022.8.14.1";
100100

101101
// Assembly copyright information
102102
public const string Copyright = "Copyright \xA9 2006-2022, Eric Woodruff, All Rights Reserved";

‎SHFB/Source/SandcastleCore/PresentationStyle/Transformation/TopicTransformationCore.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// System : Sandcastle Tools - Sandcastle Tools Core Class Library
33
// File : TopicTransformationCore.cs
44
// Author : Eric Woodruff ([email protected])
5-
// Updated : 08/07/2022
5+
// Updated : 08/15/2022
66
// Note : Copyright 2022, Eric Woodruff, All rights reserved
77
//
88
// 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)
12871287
titleParam.Add(this.ApiTopicShortNameDecorated());
12881288

12891289
// Only show parameters for operators and overloaded members
1290-
if(this.ApiMember.ApiSubSubgroup == ApiMemberGroup.Operator &&
1290+
if(this.ApiMember.ApiTopicSubgroup != ApiMemberGroup.Overload &&
1291+
this.ApiMember.ApiSubSubgroup == ApiMemberGroup.Operator &&
12911292
(this.ApiMember.Name.Equals("Explicit", StringComparison.Ordinal) ||
12921293
this.ApiMember.Name.Equals("Implicit", StringComparison.Ordinal)))
12931294
{

‎SHFB/Source/SandcastleCore/Properties/AssemblyInfoShared.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//===============================================================================================================
22
// System : Sandcastle Tools
33
// File : AssemblyInfoShared.cs
4-
// Updated : 08/14/2022
4+
// Updated : 08/15/2022
55
// Note : Copyright 2006-2022, Microsoft Corporation, All rights reserved
66
//
77
// Sandcastle tools common assembly attributes.
@@ -73,13 +73,13 @@ internal static partial class AssemblyInfo
7373
//
7474
// This is used to set the assembly file version. This will change with each new release. MSIs only
7575
// support a Major value between 0 and 255 so we drop the century from the year on this one.
76-
public const string FileVersion = "22.8.14.0";
76+
public const string FileVersion = "22.8.14.1";
7777

7878
// Common product version
7979
//
8080
// This may contain additional text to indicate Alpha or Beta states. The version number will always match
8181
// the file version above but includes the century on the year.
82-
public const string ProductVersion = "2022.8.14.0";
82+
public const string ProductVersion = "2022.8.14.1";
8383

8484
// Assembly copyright information
8585
public const string Copyright = "Copyright \xA9 2006-2022, Microsoft Corporation, All Rights Reserved.\r\n" +

0 commit comments

Comments
 (0)