Skip to content

Commit 8379999

Browse files
EWSoftwareEWSoftware
committed
Initial check in
1 parent 5d4a691 commit 8379999

34 files changed

+2942
-2
lines changed

‎.gitattributes‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎.gitignore‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
## Ignore Visual Studio temporary files, build results, and
2+
## files generated by popular Visual Studio add-ons.
3+
4+
# User-specific files
5+
*.suo
6+
*.user
7+
*.userosscache
8+
*.sln.docstates
9+
StyleCop.Cache
10+
_ReSharper*/
11+
*.[Rr]e[Ss]harper
12+
*.DotSettings.user
13+
14+
# Build results
15+
[Dd]ebug/
16+
[Dd]ebugPublic/
17+
[Rr]elease/
18+
[Rr]eleases/
19+
x64/
20+
x86/
21+
build/
22+
bld/
23+
[Bb]in/
24+
[Oo]bj/
25+
26+
# Roslyn cache directories
27+
*.vs/
28+
29+
# Visual Studio profiler
30+
*.psess
31+
*.vsp
32+
*.vspx
33+
34+
# Sandcastle Help File Builder is a documentation generator add-in
35+
Docs/Help/
36+
*.shfbproj_*
37+
38+
# Publish Web Output
39+
*.[Pp]ublish.xml
40+
*.pubxml
41+
*.publishproj
42+
**/PrecompiledWeb
43+
44+
# NuGet Packages
45+
*.nupkg
46+
# The packages folder can be ignored because of Package Restore
47+
**/packages/*
48+
*.lock.json
49+
50+
# Others
51+
~$*
52+
*~
53+
*.publishsettings
54+
*CodeAnalysisLog.xml
55+
WebProject.lastcodeanalysissucceeded
56+
57+
# Backup & report files from converting an old project file
58+
# to a newer Visual Studio version. Backup files are not needed,
59+
# because we have git ;-)
60+
_UpgradeReport_Files/
61+
Backup*/
62+
UpgradeLog*.XML
63+
UpgradeLog*.htm
64+
65+
# Non-distributable and private local stuff
66+
Deployment/
67+
NonDist/
68+
69+
# =========================
70+
# Operating System Files
71+
# =========================
72+
73+
# Windows
74+
# =========================
75+
76+
# Windows image file caches
77+
Thumbs.db
78+
ehthumbs.db
79+
80+
# Folder config file
81+
Desktop.ini
82+
83+
# Recycle Bin used on file shares
84+
$RECYCLE.BIN/
85+
86+
# Windows Installer files
87+
*.cab
88+
*.msi
89+
*.msm
90+
*.msp
91+
92+
# Windows shortcuts
93+
*.lnk

‎Docs/.editorconfig‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Top-most EditorConfig file
2+
root = true
3+
4+
# Don't use tabs for indentation unless otherwise overridden
5+
[*]
6+
indent_style = space
7+
end_of_line = crlf
8+
# (Please don't specify an indent_size here; that has too many unintended consequences.)
9+
10+
# XML files of various types
11+
[*.{aml,asax,ascx,asmx,asp,aspx,axml,config,content,cshtml,csproj,database,datasource,dbml,disco,discomap,dtsx,edmx,exclude,fxcop,htm,html,items,layout,maml,manifest,master,msha,myapp,nunit,nuspec,proj,projitems,props,publishproj,pubxml,rdl,rdlc,resx,ruleset,settings,shfbproj,shproj,sitemap,snippets,soap,svc,svcinfo,svcmap,targets,tasks,tokens,vbhtml,vbproj,vcxproj,vcxproj.filters,vsct,vsixmanifest,vstemplate,webinfo,wsdl,xaml,xamlcfg,xml,xsd,xsl,xslt,xsx}]
12+
indent_style = tab

‎Docs/Content/Contributing.aml‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="C60519F2-A2F7-4EB1-883F-96C51073CEB3" revisionNumber="1">
3+
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
4+
<introduction>
5+
<autoOutline excludeRelatedTopics="true" lead="none" />
6+
</introduction>
7+
8+
<section address="Issues">
9+
<title>Issues</title>
10+
<content>
11+
<para>If you don't feel like working on the code yourself, <externalLink>
12+
<linkText>filing an issue</linkText>
13+
<linkAlternateText>Extended Doc Comments Provider Issues</linkAlternateText>
14+
<linkUri>https://github.com/EWSoftware/ExtendedDocCommentsProvider/issues</linkUri>
15+
<linkTarget>_blank</linkTarget>
16+
</externalLink> and letting me handle the change is fine. You don't need to file an issue for trivial changes
17+
(i.e. typos, minor fixes, etc.). Just send a pull request if it's small.</para>
18+
19+
<para>If an issue is complex, adds or removes functionality, changes existing behavior, etc. consider
20+
filing an issue and giving me time to respond before sending a corresponding pull request. If you want to work
21+
on the issue, just let it be known on the issue thread. Giving me a chance to review the issue will help save
22+
time and prevents you from wasting time on something that cannot be implemented. For example, I might let you
23+
know why existing behavior cannot be changed or about particular implementation constraints you need to keep in
24+
mind, etc.</para>
25+
</content>
26+
</section>
27+
28+
<section address="Contributing">
29+
<title>Contributing to the Project</title>
30+
<content>
31+
<list class="ordered">
32+
<listItem>
33+
<para>Unless it is a trivial change such as a typo or minor fix, make sure that there is a
34+
corresponding issue for your change first. If there isn't, create one.</para>
35+
</listItem>
36+
37+
<listItem>
38+
<para>Create a fork in GitHub</para>
39+
</listItem>
40+
41+
<listItem>
42+
<para>Create a branch off the master branch. Name it something that makes sense, such as
43+
<legacyItalic>issue-123</legacyItalic> or <legacyItalic>githubUserID-issue</legacyItalic>. This makes it easy
44+
for everyone to figure out what the branch is used for. It also makes it easier to isolate your changes from
45+
incoming changes from the origin.</para>
46+
</listItem>
47+
48+
<listItem>
49+
<para>Commit your changes and push your changes to GitHub.</para>
50+
</listItem>
51+
52+
<listItem>
53+
<para>Create a pull request against the origin's master branch.</para>
54+
</listItem>
55+
56+
</list>
57+
</content>
58+
</section>
59+
60+
<section address="CodingStyle">
61+
<title>Coding Style</title>
62+
<content>
63+
<para>In general, use the Visual Studio defaults. Take a look at the existing code to see the styles in
64+
use. The <localUri>.editorconfig</localUri> file defines the preferred style defaults.</para>
65+
66+
<list class="ordered">
67+
<listItem>
68+
<para>In source code, use four spaces for indentation, no tabs.</para>
69+
</listItem>
70+
71+
<listItem>
72+
<para>For XML, XAML, HTML, and similar file types, use two spaces for indentation and do use tabs.</para>
73+
</listItem>
74+
75+
<listItem>
76+
<para>Namespace imports should be specified at the top of the file, outside of the
77+
<codeInline>namespace</codeInline> declaration, and should be sorted alphabetically. Place
78+
<codeInline>System.</codeInline> namespaces at the top and blank lines between different top level groups.
79+
Remove any unused namespaces to avoid unnecessary clutter.</para>
80+
</listItem>
81+
82+
<listItem>
83+
<!-- Ignore spelling: Allman -->
84+
<para>Use Allman style braces where each brace begins on a new line. A single line statement block
85+
can go without braces but the block must be properly indented on its own line.</para>
86+
</listItem>
87+
88+
<listItem>
89+
<para>Do not insert spaces after keywords in control flow statements (use <codeInline>if(a &lt; b)</codeInline>
90+
instead of <codeInline>if (a &lt; b)</codeInline>).</para>
91+
</listItem>
92+
93+
<listItem>
94+
<para>Use <codeInline>camelCase</codeInline> private members without leading underscores or other
95+
such prefixes like <codeInline>m_</codeInline>.</para>
96+
</listItem>
97+
98+
<listItem>
99+
<para>Always specify the visibility even if it is the default (i.e. <codeInline>private string foo</codeInline>
100+
not <codeInline>string foo</codeInline>).</para>
101+
</listItem>
102+
103+
</list>
104+
</content>
105+
</section>
106+
107+
<relatedTopics>
108+
<link xlink:href="141160ac-ba6a-4f6d-a802-1110aadea932" />
109+
<externalLink>
110+
<linkText>License Agreement</linkText>
111+
<linkUri>https://github.com/EWSoftware/ExtendedDocCommentsProvider/blob/master/LICENSE</linkUri>
112+
<linkTarget>_blank</linkTarget>
113+
</externalLink>
114+
</relatedTopics>
115+
</developerConceptualDocument>
116+
</topic>

‎Docs/Content/Installation.aml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="102EF998-5094-482A-B708-9DA64C04C859" 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>To install this package:</para>
6+
</introduction>
7+
8+
<section>
9+
<content>
10+
<list class="bullet">
11+
<listItem>
12+
<para>Download the latest release of the VSIX installer from the <externalLink>
13+
<linkText>Releases</linkText>
14+
<linkUri>https://GitHub.com/EWSoftware/ExtendedDocCommentsProvider/releases</linkUri>
15+
<linkTarget>_blank</linkTarget>
16+
</externalLink> page of this project site. The package can be installed in Visual Studio 2019 or later.</para>
17+
</listItem>
18+
19+
<listItem>
20+
<para>Close all open instances of Visual Studio before installing the package.</para>
21+
</listItem>
22+
23+
<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>
28+
</listItem>
29+
30+
</list>
31+
32+
<para>This package can also be installed from within Visual Studio from the Visual Studio Marketplace
33+
(<externalLink>
34+
<linkText>Visual Studio 2019 or later</linkText>
35+
<linkUri>https://marketplace.visualstudio.com/items?itemName=EWoodruff.ExtendedDocCommentsProvider</linkUri>
36+
<linkTarget>_blank</linkTarget>
37+
</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
39+
<legacyItalic>EWSoftware</legacyItalic>. Once found, you can click the <ui>Download</ui> button to download and
40+
install it.</para>
41+
42+
<para>Once installed, the extended elements, attributes, and attribute values will be provided in the
43+
completion popup list in the source code editor when entering XML comments.</para>
44+
45+
</content>
46+
</section>
47+
48+
<relatedTopics>
49+
<link xlink:href="141160ac-ba6a-4f6d-a802-1110aadea932" />
50+
</relatedTopics>
51+
</developerConceptualDocument>
52+
</topic>

‎Docs/Content/KnownIssues.aml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<topic id="b146cb94-e594-4462-9262-d5cdba76c331" 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>The following are some known issues.</para>
6+
</introduction>
7+
8+
<section address="Section1">
9+
<content>
10+
<list class="bullet">
11+
<listItem>
12+
<para>Completion providers are additive. Each one returns a set of items to add to the completion
13+
list based on the current editor context. The providers are unaware of other providers and the items added by
14+
them. They cannot remove items from other providers or make decisions about what to add based on other items
15+
that may appear.</para>
16+
17+
<para>As such, you will see completion items from the built-in XML comments completion provider that
18+
may not be appropriate. For example, you will see the standard set of inline elements inside of the
19+
<codeInline>revisionHistory</codeInline> element. The same issue can be seen with standard elements such
20+
as <codeInline>list</codeInline>. This provider does allow the definition of valid parent elements so it will
21+
not present the custom child elements in inappropriate contexts.</para>
22+
</listItem>
23+
24+
<listItem>
25+
<para>Only C# is supported right now. A provider for Visual Basic is planned for a later release.</para>
26+
</listItem>
27+
28+
<listItem>
29+
<para>The current set of extended elements, attributes, and values is currently fixed and cannot be
30+
changed. A future release will allow the items to be customized and additional user-defined elements to be
31+
added.</para>
32+
</listItem>
33+
</list>
34+
</content>
35+
</section>
36+
37+
<relatedTopics>
38+
39+
</relatedTopics>
40+
</developerConceptualDocument>
41+
</topic>

0 commit comments

Comments
 (0)