Skip to content

Commit 42f2950

Browse files
committed
Minor update
- Added support for the todo note type and the title attribute on the note XML comments element. - Updated the help project to use the new Default2022 style. - Split the projects into separate solutions for VS2019 and VS2022.
1 parent 63a5445 commit 42f2950

20 files changed

+205
-116
lines changed

Docs/Content/Installation.aml

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,33 +9,37 @@
99
<content>
1010
<list class="bullet">
1111
<listItem>
12-
<para>Download the latest release of the VSIX installer from the <externalLink>
12+
<para>Download the latest release of the VSIX installer for your version of Visual Studio from the
13+
<externalLink>
1314
<linkText>Releases</linkText>
1415
<linkUri>https://GitHub.com/EWSoftware/ExtendedDocCommentsProvider/releases</linkUri>
1516
<linkTarget>_blank</linkTarget>
16-
</externalLink> page of this project site. The package can be installed in Visual Studio 2019 or later.</para>
17+
</externalLink> page of the project site. The package can be installed in Visual Studio 2019 or Visual Studio
18+
2022 or later.</para>
1719
</listItem>
1820

1921
<listItem>
2022
<para>Close all open instances of Visual Studio before installing the package.</para>
2123
</listItem>
2224

2325
<listItem>
24-
<para>Run the downloaded package and follow the prompts to install it. It can be installed in any
25-
edition of Visual Studio except Express editions. Express editions are not supported as they do not allow
26-
installation of third-party extensions. Consider switching to the newer Community Edition which does support
27-
them.</para>
26+
<para>Run the downloaded package and follow the prompts to install it.</para>
2827
</listItem>
2928

3029
</list>
3130

3231
<para>This package can also be installed from within Visual Studio from the Visual Studio Marketplace
3332
(<externalLink>
34-
<linkText>Visual Studio 2019 or later</linkText>
33+
<linkText>Visual Studio 2019</linkText>
3534
<linkUri>https://marketplace.visualstudio.com/items?itemName=EWoodruff.ExtendedDocCommentsProvider</linkUri>
3635
<linkTarget>_blank</linkTarget>
36+
</externalLink> or
37+
<externalLink>
38+
<linkText>Visual Studio 2022 or later</linkText>
39+
<linkUri>https://marketplace.visualstudio.com/items?itemName=EWoodruff.ExtendedDocCommentsProvider2022</linkUri>
40+
<linkTarget>_blank</linkTarget>
3741
</externalLink>) using the <ui>Tools | Extension and Updates</ui> option. Select the online marketplace and
38-
search for "completion provider". Include the quote marks for an exact match and find the one created by
42+
search for "doc comments provider". Include the quote marks for an exact match and find the one created by
3943
<legacyItalic>EWSoftware</legacyItalic>. Once found, you can click the <ui>Download</ui> button to download and
4044
install it.</para>
4145

Docs/Content/SystemRequirements.aml

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,7 @@
33
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
44
<introduction>
55
<para>The master branch is for Visual Studio 2019 and later and is the default branch for all current and
6-
future development. In order to build the projects you will need the following tools:</para>
7-
8-
<list class="bullet">
9-
<listItem>
10-
<para>For the master branch, you will need Visual Studio 2019 or later.</para>
11-
</listItem>
12-
13-
</list>
6+
future development. In order to build the projects you will need Visual Studio 2019 or later.</para>
147
</introduction>
158

169
<section>
@@ -34,10 +27,9 @@ and all related files) generated by building the projects.</para>
3427
<section>
3528
<title>Building and Debugging the Projects</title>
3629
<content>
37-
<para>To build the projects, open the solution file (<localUri>*.sln</localUri>) found in the
38-
<localUri>Source\</localUri> folder and build it. You can also run the <localUri>MasterBuild.bat</localUri>
39-
script from a command prompt to build the projects. The projects should be built at least once in Visual
40-
Studio so that all of the necessary NuGet packages are restored and available for the command line build.</para>
30+
<para>To build the projects, open the solution file (<localUri>*.sln</localUri>) for your version of
31+
Visual Studio (currently 2019 or 2022) found in the <localUri>Source\</localUri> folder and build it. You can
32+
also run the <localUri>MasterBuild.bat</localUri> script from a command prompt to build the projects.</para>
4133

4234
<para>In order to debug the projects:</para>
4335

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="23ea721a-0a75-48c7-8457-7614bf3c4926" />
16+
</para>
17+
</listItem>
18+
1319
<listItem>
1420
<para>
1521
<link xlink:href="16fd137b-699a-4260-906f-59d94818ff7a" />
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="23ea721a-0a75-48c7-8457-7614bf3c4926" 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 support for the <codeInline>title</codeInline> attribute and the <codeInline>todo</codeInline>
14+
note type for the <codeInline>note</codeInline> XML comments element.</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/Content/Welcome.aml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<para>Welcome to the <legacyBold>Extended XML Documentation Comments Completion Provider</legacyBold> project.</para>
66
</introduction>
77

8-
<!-- Ignore Spelling: cpp, fs, javascript, vbnet, html, xml, xsl, xaml, sql, py, pshell href threadsafety seealso -->
8+
<!-- Ignore Spelling: cpp, fs, javascript, vbnet, html, xml, xsl, xaml, sql, py, pshell href threadsafety seealso todo -->
99

1010
<section>
1111
<content>
@@ -200,7 +200,18 @@ Builder and other documentation tools. The following elements, attributes, and
200200
<para>type</para>
201201
</entry>
202202
<entry>
203-
<para>note, tip, implement, caller, inherit, caution, warning, important, security, cs, cpp, vb</para>
203+
<para>note, tip, implement, caller, inherit, caution, warning, important, security, cs, cpp, vb, todo</para>
204+
</entry>
205+
</row>
206+
<row>
207+
<entry>
208+
<para>&#160;</para>
209+
</entry>
210+
<entry>
211+
<para>title</para>
212+
</entry>
213+
<entry>
214+
<para>&#160;</para>
204215
</entry>
205216
</row>
206217
<row>

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="16fd137b-699a-4260-906f-59d94818ff7a" visible="True" isSelected="true" title="Version 2021.7.5.0">
33+
<Topic id="23ea721a-0a75-48c7-8457-7614bf3c4926" visible="True" isSelected="true" title="Version 2022.7.29.0">
34+
<HelpKeywords>
35+
<HelpKeyword index="K" term="versions, 2022.7.29.0" />
36+
</HelpKeywords>
37+
</Topic>
38+
<Topic id="16fd137b-699a-4260-906f-59d94818ff7a" visible="True" title="Version 2021.7.5.0">
3439
<HelpKeywords>
3540
<HelpKeyword index="K" term="versions, 2021.7.5.0" />
3641
</HelpKeywords>

Docs/ExtendedDocCommentsProviderDocs.shfbproj

Lines changed: 25 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -13,81 +13,55 @@
1313
<RootNamespace>ExtendedDocCommentsProviderDocs</RootNamespace>
1414
<Name>ExtendedDocCommentsProviderDocs</Name>
1515
<!-- SHFB properties -->
16-
<FrameworkVersion>.NET Framework 4.7.2</FrameworkVersion>
16+
<FrameworkVersion>.NET Framework 4.8</FrameworkVersion>
1717
<OutputPath>.\Help\</OutputPath>
1818
<HtmlHelpName>ExtendedDocCommentsProvider</HtmlHelpName>
1919
<Language>en-US</Language>
2020
<TransformComponentArguments>
21-
<Argument Key="logoFile" Value="" />
22-
<Argument Key="logoHeight" Value="" />
23-
<Argument Key="logoWidth" Value="" />
24-
<Argument Key="logoAltText" Value="" />
25-
<Argument Key="logoPlacement" Value="left" />
26-
<Argument Key="logoAlignment" Value="left" />
27-
<Argument Key="maxVersionParts" Value="" />
28-
<Argument Key="defaultLanguage" Value="cs" />
29-
<Argument Key="includeEnumValues" Value="true" />
30-
<Argument Key="baseSourceCodeUrl" Value="" />
31-
<Argument Key="requestExampleUrl" Value="" />
21+
<Argument Key="RobotsMetadata" Value="" />
22+
<Argument Key="BibliographyDataFile" Value="" />
23+
<Argument Key="RootBreadcrumbTitleText" Value="Extended Doc Comments" />
24+
<Argument Key="CollapsibleSections" Value="True" />
25+
<Argument Key="LogoFile" Value="" />
26+
<Argument Key="LogoHeight" Value="" />
27+
<Argument Key="LogoWidth" Value="" />
28+
<Argument Key="LogoAltText" Value="" />
29+
<Argument Key="LogoPlacement" Value="Left" />
30+
<Argument Key="LogoAlignment" Value="Left" />
31+
<Argument Key="LogoUrl" Value="" />
32+
<Argument Key="MaxVersionParts" Value="" />
33+
<Argument Key="DefaultLanguage" Value="cs" />
34+
<Argument Key="IncludeEnumValues" Value="True" />
35+
<Argument Key="EnumMemberSortOrder" Value="Value" />
36+
<Argument Key="FlagsEnumValueFormat" Value="IntegerValue" />
37+
<Argument Key="FlagsEnumSeparatorSize" Value="0" />
38+
<Argument Key="BaseSourceCodeUrl" Value="" />
39+
<Argument Key="RequestExampleUrl" Value="" />
3240
</TransformComponentArguments>
3341
<PlugInConfigurations>
3442
<PlugInConfig id="Additional Content Only" enabled="True">
3543
<configuration />
3644
</PlugInConfig>
37-
<PlugInConfig id="Output Deployment" enabled="True">
38-
<configuration deleteAfterDeploy="true" verboseLogging="false">
39-
<deploymentLocation id="help1x" location="">
40-
<userCredentials useDefault="true" userName="" password="" />
41-
<proxyCredentials useProxy="false" proxyServer="">
42-
<userCredentials useDefault="true" userName="" password="" />
43-
</proxyCredentials>
44-
</deploymentLocation>
45-
<deploymentLocation id="helpViewer" location="" renameMSHA="false">
46-
<userCredentials useDefault="true" userName="" password="" />
47-
<proxyCredentials useProxy="false" proxyServer="">
48-
<userCredentials useDefault="true" userName="" password="" />
49-
</proxyCredentials>
50-
</deploymentLocation>
51-
<deploymentLocation id="website" location="..\Deployment\DocWebsite\">
52-
<userCredentials useDefault="true" userName="" password="" />
53-
<proxyCredentials useProxy="false" proxyServer="">
54-
<userCredentials useDefault="true" userName="" password="" />
55-
</proxyCredentials>
56-
</deploymentLocation>
57-
<deploymentLocation id="openXml" location="">
58-
<userCredentials useDefault="true" userName="" password="" />
59-
<proxyCredentials useProxy="false" proxyServer="">
60-
<userCredentials useDefault="true" userName="" password="" />
61-
</proxyCredentials>
62-
</deploymentLocation>
63-
<deploymentLocation id="markdown" location="">
64-
<userCredentials useDefault="true" userName="" password="" />
65-
<proxyCredentials useProxy="false" proxyServer="">
66-
<userCredentials useDefault="true" userName="" password="" />
67-
</proxyCredentials>
68-
</deploymentLocation>
69-
</configuration>
70-
</PlugInConfig>
71-
</PlugInConfigurations>
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>
7246
<HelpFileFormat>Website</HelpFileFormat>
7347
<SyntaxFilters>Standard</SyntaxFilters>
74-
<PresentationStyle>VS2013</PresentationStyle>
48+
<PresentationStyle>Default2022</PresentationStyle>
7549
<CleanIntermediates>True</CleanIntermediates>
7650
<KeepLogFile>True</KeepLogFile>
7751
<DisableCodeBlockComponent>False</DisableCodeBlockComponent>
7852
<IndentHtml>False</IndentHtml>
7953
<BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity>
8054
<SaveComponentCacheCapacity>100</SaveComponentCacheCapacity>
8155
<HelpTitle>Extended XML Documentation Comments Provider</HelpTitle>
82-
<HelpFileVersion>2019.10.27.0</HelpFileVersion>
56+
<HelpFileVersion>2022.7.29.0</HelpFileVersion>
8357
<NamingMethod>Guid</NamingMethod>
8458
<ContentPlacement>AboveNamespaces</ContentPlacement>
8559
<RootNamespaceContainer>False</RootNamespaceContainer>
8660
<NamespaceGrouping>False</NamespaceGrouping>
8761
<MaximumGroupParts>2</MaximumGroupParts>
8862
<Preliminary>False</Preliminary>
8963
<CopyrightHref>https://GitHub.com/EWSoftware/ExtendedDocCommentsProvider</CopyrightHref>
90-
<CopyrightText>Copyright \xA9 2019, Eric Woodruff, All rights reserved</CopyrightText>
64+
<CopyrightText>Copyright \xA9 2019-2022, Eric Woodruff, All rights reserved</CopyrightText>
9165
<FeedbackEMailAddress>Eric%40EWoodruff.us</FeedbackEMailAddress>
9266
<SdkLinkTarget>Blank</SdkLinkTarget>
9367
<HtmlSdkLinkType>Msdn</HtmlSdkLinkType>
@@ -139,6 +113,7 @@
139113
<None Include="Content\SystemRequirements.aml" />
140114
<None Include="Content\VersionHistory\v2019.10.27.0.aml" />
141115
<None Include="Content\VersionHistory\v2021.7.5.0.aml" />
116+
<None Include="Content\VersionHistory\v2022.7.29.0.aml" />
142117
<None Include="Content\VersionHistory\VersionHistory.aml" />
143118
<None Include="Content\Welcome.aml" />
144119
</ItemGroup>

MasterBuild.bat

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,41 @@ SETLOCAL
44

55
CD Source
66

7-
ECHO *
8-
ECHO * VS2019 and later package
9-
ECHO *
10-
117
REM Use MSBuild from whatever edition of Visual Studio is installed
12-
IF EXIST "%ProgramFiles%\Microsoft Visual Studio\2022\Community\MSBuild\Current" SET "MSBUILD=%ProgramFiles%\Microsoft Visual Studio\2022\Community\MSBuild\Current\bin\MSBuild.exe"
13-
IF EXIST "%ProgramFiles%\Microsoft Visual Studio\2022\Professional\MSBuild\Current" SET "MSBUILD=%ProgramFiles%\Microsoft Visual Studio\2022\Professional\MSBuild\Current\bin\MSBuild.exe"
14-
IF EXIST "%ProgramFiles%\Microsoft Visual Studio\2022\Enterprise\MSBuild\Current" SET "MSBUILD=%ProgramFiles%\Microsoft Visual Studio\2022\Enterprise\MSBuild\Current\bin\MSBuild.exe"
158
IF EXIST "%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Community\MSBuild\Current" SET "MSBUILD=%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Community\MSBuild\Current\bin\MSBuild.exe"
169
IF EXIST "%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Professional\MSBuild\Current" SET "MSBUILD=%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Professional\MSBuild\Current\bin\MSBuild.exe"
1710
IF EXIST "%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\MSBuild\Current" SET "MSBUILD=%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\MSBuild\Current\bin\MSBuild.exe"
1811

19-
IF NOT EXIST "%MSBUILD%" GOTO End
12+
IF EXIST "%ProgramFiles%\Microsoft Visual Studio\2022\Community\MSBuild\Current" SET "MSBUILD2022=%ProgramFiles%\Microsoft Visual Studio\2022\Community\MSBuild\Current\bin\MSBuild.exe"
13+
IF EXIST "%ProgramFiles%\Microsoft Visual Studio\2022\Professional\MSBuild\Current" SET "MSBUILD2022=%ProgramFiles%\Microsoft Visual Studio\2022\Professional\MSBuild\Current\bin\MSBuild.exe"
14+
IF EXIST "%ProgramFiles%\Microsoft Visual Studio\2022\Enterprise\MSBuild\Current" SET "MSBUILD2022=%ProgramFiles%\Microsoft Visual Studio\2022\Enterprise\MSBuild\Current\bin\MSBuild.exe"
15+
16+
IF NOT EXIST "%MSBUILD%" GOTO Build2022
2017

21-
"%MSBUILD%" ExtendedDocCommentsProvider.sln /nologo /v:m /m /t:Clean;Build "/p:Configuration=Release;Platform=Any CPU"
18+
ECHO *
19+
ECHO * VS2019 package
20+
ECHO *
21+
22+
"%MSBUILD%" ExtendedDocCommentsProvider2019.sln /nologo /v:m /m /t:Clean;Build "/p:Configuration=Release;Platform=Any CPU"
2223

2324
IF ERRORLEVEL 1 GOTO End
2425

26+
:Build2022
27+
IF NOT EXIST "%MSBUILD2022%" GOTO BuildDocs
28+
29+
ECHO *
30+
ECHO * VS2022 and later package
31+
ECHO *
32+
33+
"%MSBUILD2022%" ExtendedDocCommentsProvider2022.sln /nologo /v:m /m /t:Clean;Build "/p:Configuration=Release;Platform=Any CPU"
34+
35+
IF ERRORLEVEL 1 GOTO End
36+
37+
:BuildDocs
2538
CD ..\
2639

40+
IF NOT EXIST "%MSBUILD%" SET "MSBUILD=%MSBUILD2022%"
41+
2742
IF NOT "%SHFBROOT%"=="" "%MSBUILD%" /nologo /v:m "Docs\ExtendedDocCommentsProviderDocs.sln" /t:Clean;Build "/p:Configuration=Release;Platform=Any CPU"
2843

2944
IF "%SHFBROOT%"=="" ECHO **** Sandcastle help file builder not installed. Skipping help build. ****

Source/ExtendedDocCommentsProvider.Shared/CSharpXmlDocCommentsCompletionProvider.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
// System : Extended Doc Comments Completion Provider Package
33
// File : CSharpXmlDocCommentsCompletionProvider.cs
44
// Author : Eric Woodruff ([email protected])
5-
// Updated : 07/05/2021
6-
// Note : Copyright 2019-2021, Eric Woodruff, All rights reserved
5+
// Updated : 07/29/2021
6+
// Note : Copyright 2019-2022, Eric Woodruff, All rights reserved
77
//
88
// This file contains the extended documentation comments completion provider for C#
99
//
@@ -194,7 +194,7 @@ private static async Task<IEnumerable<CompletionItem>> GetItemsAsync(Document do
194194
var token = tree.FindTokenOnLeftOfPosition(position, cancellationToken);
195195
var parentTrivia = token.Parent?.FirstAncestorOrSelf<DocumentationCommentTriviaSyntax>();
196196

197-
if(parentTrivia == null || parentTrivia.ParentTrivia.Token.Kind() == SyntaxKind.None)
197+
if(parentTrivia == null || parentTrivia.ParentTrivia.Token.IsKind(SyntaxKind.None))
198198
return null;
199199

200200
// Offer attribute names based on the element

Source/ExtendedDocCommentsProvider.Shared/CommentsElement.cs

Lines changed: 6 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 : CommentsElement.cs
44
// Author : Eric Woodruff ([email protected])
5-
// Updated : 10/22/2019
6-
// Note : Copyright 2019, Eric Woodruff, All rights reserved
5+
// Updated : 07/29/2022
6+
// Note : Copyright 2019-2022, Eric Woodruff, All rights reserved
77
//
88
// This file contains the class used to define an XML documentation comments element
99
//
@@ -17,7 +17,7 @@
1717
// 10/18/2019 EFW Created the code
1818
//===============================================================================================================
1919

20-
// Ignore Spelling: cpp fs javascript vbnet html xml xsl xaml sql py pshell cref threadsafety href seealso
20+
// Ignore Spelling: cpp fs javascript vbnet html xml xsl xaml sql py pshell cref threadsafety href seealso todo
2121

2222
using System;
2323
using System.Collections.Generic;
@@ -343,8 +343,9 @@ private static Dictionary<string, CommentsElement> CreateDefaultCommentElements(
343343
Description = "Create a note within a topic to draw attention to some important information."
344344
}.AddAttributes(new [] {
345345
new ElementAttribute(new[] { "note", "tip", "implement", "caller", "inherit", "caution",
346-
"warning", "important", "security", "cs", "cpp", "vb" }) {
347-
Name = "type", Description = "Specifies the note type." }
346+
"warning", "important", "security", "cs", "cpp", "vb", "todo" }) {
347+
Name = "type", Description = "Specifies the note type." },
348+
new ElementAttribute { Name = "title", Description = "An optional title override" }
348349
}),
349350
new CommentsElement
350351
{

0 commit comments

Comments
 (0)