Skip to content

Commit 938ddbc

Browse files
committed
Added missing self-closing option to see and seealso
Fixes #3.
1 parent 42f2950 commit 938ddbc

File tree

8 files changed

+87
-13
lines changed

8 files changed

+87
-13
lines changed

Docs/Content/VersionHistory/VersionHistory.aml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ over the life of the project. Select a version below to see a description of it
1010
<section>
1111
<content>
1212
<list class="bullet">
13+
<listItem>
14+
<para>
15+
<link xlink:href="6857ece7-59b8-4ad0-86bd-ae7453b97faf" />
16+
</para>
17+
</listItem>
18+
1319
<listItem>
1420
<para>
1521
<link xlink:href="23ea721a-0a75-48c7-8457-7614bf3c4926" />
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="6857ece7-59b8-4ad0-86bd-ae7453b97faf" 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>Changes made in this release:</para>
6+
</introduction>
7+
8+
<section>
9+
<content>
10+
11+
<list class="bullet">
12+
<listItem>
13+
<para>Added the self-closing option to the <codeInline>see</codeInline> and <codeInline>seealso</codeInline>
14+
elements.</para>
15+
</listItem>
16+
</list>
17+
18+
</content>
19+
</section>
20+
21+
<relatedTopics>
22+
<link xlink:href="caa20db4-521f-4c4c-8399-aea8a81ae6a7" />
23+
</relatedTopics>
24+
25+
</developerConceptualDocument>
26+
</topic>

Docs/ContentLayout.content

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,12 @@
3030
<HelpKeywords>
3131
<HelpKeyword index="K" term="version, history" />
3232
</HelpKeywords>
33-
<Topic id="23ea721a-0a75-48c7-8457-7614bf3c4926" visible="True" isSelected="true" title="Version 2022.7.29.0">
33+
<Topic id="6857ece7-59b8-4ad0-86bd-ae7453b97faf" visible="True" isSelected="true" title="Version 2023.2.12.0">
34+
<HelpKeywords>
35+
<HelpKeyword index="K" term="versions, 2023.2.12.0" />
36+
</HelpKeywords>
37+
</Topic>
38+
<Topic id="23ea721a-0a75-48c7-8457-7614bf3c4926" visible="True" title="Version 2022.7.29.0">
3439
<HelpKeywords>
3540
<HelpKeyword index="K" term="versions, 2022.7.29.0" />
3641
</HelpKeywords>

Docs/ExtendedDocCommentsProviderDocs.shfbproj

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,41 @@
4242
<PlugInConfig id="Additional Content Only" enabled="True">
4343
<configuration />
4444
</PlugInConfig>
45-
<PlugInConfig id="Output Deployment" enabled="True"><configuration deleteAfterDeploy="true" verboseLogging="false"><deploymentLocation id="help1x" location=""><userCredentials useDefault="true" userName="" password="" /><proxyCredentials useProxy="false" proxyServer=""><userCredentials useDefault="true" userName="" password="" /></proxyCredentials></deploymentLocation><deploymentLocation id="helpViewer" location="" renameMSHA="false"><userCredentials useDefault="true" userName="" password="" /><proxyCredentials useProxy="false" proxyServer=""><userCredentials useDefault="true" userName="" password="" /></proxyCredentials></deploymentLocation><deploymentLocation id="website" location="..\Deployment\DocWebsite\"><userCredentials useDefault="true" userName="" password="" /><proxyCredentials useProxy="false" proxyServer=""><userCredentials useDefault="true" userName="" password="" /></proxyCredentials></deploymentLocation><deploymentLocation id="openXml" location=""><userCredentials useDefault="true" userName="" password="" /><proxyCredentials useProxy="false" proxyServer=""><userCredentials useDefault="true" userName="" password="" /></proxyCredentials></deploymentLocation><deploymentLocation id="markdown" location=""><userCredentials useDefault="true" userName="" password="" /><proxyCredentials useProxy="false" proxyServer=""><userCredentials useDefault="true" userName="" password="" /></proxyCredentials></deploymentLocation></configuration></PlugInConfig></PlugInConfigurations>
45+
<PlugInConfig id="Output Deployment" enabled="True">
46+
<configuration deleteAfterDeploy="true" verboseLogging="false">
47+
<deploymentLocation id="help1x" location="">
48+
<userCredentials useDefault="true" userName="" password="" />
49+
<proxyCredentials useProxy="false" proxyServer="">
50+
<userCredentials useDefault="true" userName="" password="" />
51+
</proxyCredentials>
52+
</deploymentLocation>
53+
<deploymentLocation id="helpViewer" location="" renameMSHA="false">
54+
<userCredentials useDefault="true" userName="" password="" />
55+
<proxyCredentials useProxy="false" proxyServer="">
56+
<userCredentials useDefault="true" userName="" password="" />
57+
</proxyCredentials>
58+
</deploymentLocation>
59+
<deploymentLocation id="website" location="..\Deployment\DocWebsite\">
60+
<userCredentials useDefault="true" userName="" password="" />
61+
<proxyCredentials useProxy="false" proxyServer="">
62+
<userCredentials useDefault="true" userName="" password="" />
63+
</proxyCredentials>
64+
</deploymentLocation>
65+
<deploymentLocation id="openXml" location="">
66+
<userCredentials useDefault="true" userName="" password="" />
67+
<proxyCredentials useProxy="false" proxyServer="">
68+
<userCredentials useDefault="true" userName="" password="" />
69+
</proxyCredentials>
70+
</deploymentLocation>
71+
<deploymentLocation id="markdown" location="">
72+
<userCredentials useDefault="true" userName="" password="" />
73+
<proxyCredentials useProxy="false" proxyServer="">
74+
<userCredentials useDefault="true" userName="" password="" />
75+
</proxyCredentials>
76+
</deploymentLocation>
77+
</configuration>
78+
</PlugInConfig>
79+
</PlugInConfigurations>
4680
<HelpFileFormat>Website</HelpFileFormat>
4781
<SyntaxFilters>Standard</SyntaxFilters>
4882
<PresentationStyle>Default2022</PresentationStyle>
@@ -53,15 +87,15 @@
5387
<BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity>
5488
<SaveComponentCacheCapacity>100</SaveComponentCacheCapacity>
5589
<HelpTitle>Extended XML Documentation Comments Provider</HelpTitle>
56-
<HelpFileVersion>2022.7.29.0</HelpFileVersion>
90+
<HelpFileVersion>2023.2.12.0</HelpFileVersion>
5791
<NamingMethod>Guid</NamingMethod>
5892
<ContentPlacement>AboveNamespaces</ContentPlacement>
5993
<RootNamespaceContainer>False</RootNamespaceContainer>
6094
<NamespaceGrouping>False</NamespaceGrouping>
6195
<MaximumGroupParts>2</MaximumGroupParts>
6296
<Preliminary>False</Preliminary>
6397
<CopyrightHref>https://GitHub.com/EWSoftware/ExtendedDocCommentsProvider</CopyrightHref>
64-
<CopyrightText>Copyright \xA9 2019-2022, Eric Woodruff, All rights reserved</CopyrightText>
98+
<CopyrightText>Copyright \xA9 2019-2023, Eric Woodruff, All rights reserved</CopyrightText>
6599
<FeedbackEMailAddress>Eric%40EWoodruff.us</FeedbackEMailAddress>
66100
<SdkLinkTarget>Blank</SdkLinkTarget>
67101
<HtmlSdkLinkType>Msdn</HtmlSdkLinkType>
@@ -114,6 +148,7 @@
114148
<None Include="Content\VersionHistory\v2019.10.27.0.aml" />
115149
<None Include="Content\VersionHistory\v2021.7.5.0.aml" />
116150
<None Include="Content\VersionHistory\v2022.7.29.0.aml" />
151+
<None Include="Content\VersionHistory\v2023.2.12.0.aml" />
117152
<None Include="Content\VersionHistory\VersionHistory.aml" />
118153
<None Include="Content\Welcome.aml" />
119154
</ItemGroup>

Source/ExtendedDocCommentsProvider.Shared/CommentsElement.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
// System : Extended Doc Comments Completion Provider Package
33
// File : CommentsElement.cs
44
// Author : Eric Woodruff (Eric@EWoodruff.us)
5-
// Updated : 07/29/2022
6-
// Note : Copyright 2019-2022, Eric Woodruff, All rights reserved
5+
// Updated : 02/10/2023
6+
// Note : Copyright 2019-2023, Eric Woodruff, All rights reserved
77
//
88
// This file contains the class used to define an XML documentation comments element
99
//
@@ -395,6 +395,7 @@ private static Dictionary<string, CommentsElement> CreateDefaultCommentElements(
395395
ElementUsage = ElementUsage.Nested,
396396
TextBeforeCaret = "cref=\"",
397397
TextAfterCaret = "\"",
398+
IsSelfClosing = true,
398399
Description = "Create an inline link to another API topic or an external website."
399400
}.AddAttributes(new[] {
400401
new ElementAttribute(new[] { "true", "false" }) {
@@ -414,6 +415,7 @@ private static Dictionary<string, CommentsElement> CreateDefaultCommentElements(
414415
ElementUsage = ElementUsage.Nested,
415416
TextBeforeCaret = "cref=\"",
416417
TextAfterCaret = "\"",
418+
IsSelfClosing = true,
417419
Description = "Create an link to another API topic or an external website in the See Also " +
418420
"section of a help topic."
419421
}.AddAttributes(new[] {

Source/ExtendedDocCommentsProvider2019/Properties/AssemblyInfo.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
// System : Extended Doc Comments Completion Provider Package
33
// File : AssemblyInfo.cs
44
// Author : Eric Woodruff (Eric@EWoodruff.us)
5-
// Updated : 07/29/2021
6-
// Note : Copyright 2019-2022, Eric Woodruff, All rights reserved
5+
// Updated : 02/12/2023
6+
// Note : Copyright 2019-2023, Eric Woodruff, All rights reserved
77
//
88
// Extended documentation comments completion provider package attributes
99
//
@@ -56,16 +56,16 @@
5656

5757
// Common assembly strong name version - Typically not change unless necessary but doesn't apply to this project
5858
// as it is self-contained and is not referenced by anything else. Keep it in sync with the versions below.
59-
[assembly: AssemblyVersion("2022.7.29.0")]
59+
[assembly: AssemblyVersion("2023.2.12.0")]
6060

6161
// Common assembly file version
6262
//
6363
// This is used to set the assembly file version. This will change with each new release. MSIs only support a
6464
// Major value between 0 and 255 so we drop the century from the year on this one.
65-
[assembly: AssemblyFileVersion("22.7.29.0")]
65+
[assembly: AssemblyFileVersion("23.2.12.0")]
6666

6767
// Common product version
6868
//
6969
// This may contain additional text to indicate Alpha or Beta states. The version number will always match the
7070
// file version above but includes the century on the year.
71-
[assembly: AssemblyInformationalVersion("2022.7.29.0")]
71+
[assembly: AssemblyInformationalVersion("2023.2.12.0")]

Source/ExtendedDocCommentsProvider2019/source.extension.vsixmanifest

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
<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">
33
<Metadata>
4-
<Identity Id="ExtendedXmlDocCommentsCompletionProvider.631a0e78-19cf-4988-a089-303350a4f094" Version="2022.7.29.0" Language="en-US" Publisher="EWSoftware" />
4+
<Identity Id="ExtendedXmlDocCommentsCompletionProvider.631a0e78-19cf-4988-a089-303350a4f094" Version="2023.2.12.0" Language="en-US" Publisher="EWSoftware" />
55
<DisplayName>Extended XML Doc Comments Provider (VS2019)</DisplayName>
66
<Description xml:space="preserve">An editor extension that augments the standard C# XML documentation comments elements with custom elements, attributes, and attribute values supported by the Sandcastle Help File Builder and other documentation tools.</Description>
77
<MoreInfo>https://github.com/EWSoftware/ExtendedDocCommentsProvider</MoreInfo>

Source/ExtendedDocCommentsProvider2022/source.extension.vsixmanifest

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
<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">
33
<Metadata>
4-
<Identity Id="ExtendedXmlDocCommentsCompletionProvider.81A83AB8-8153-4F50-B9BC-C851F019EE5C" Version="2022.7.29.0" Language="en-US" Publisher="EWSoftware" />
4+
<Identity Id="ExtendedXmlDocCommentsCompletionProvider.81A83AB8-8153-4F50-B9BC-C851F019EE5C" Version="2023.2.12.0" Language="en-US" Publisher="EWSoftware" />
55
<DisplayName>Extended XML Doc Comments Provider (VS2022+)</DisplayName>
66
<Description xml:space="preserve">An editor extension that augments the standard C# XML documentation comments elements with custom elements, attributes, and attribute values supported by the Sandcastle Help File Builder and other documentation tools.</Description>
77
<MoreInfo>https://github.com/EWSoftware/ExtendedDocCommentsProvider</MoreInfo>

0 commit comments

Comments
 (0)