Skip to content

Commit 55349f4

Browse files
sharwellOceania2018
authored andcommitted
Enable documentation comment analysis
1 parent dfd171f commit 55349f4

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

Directory.Build.props

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Project>
3+
4+
<PropertyGroup>
5+
<!--
6+
Make sure any documentation comments which are included in code get checked for syntax during the build, but do
7+
not report warnings for missing comments.
8+
9+
CS1573: Parameter 'parameter' has no matching param tag in the XML comment for 'parameter' (but other parameters do)
10+
CS1591: Missing XML comment for publicly visible type or member 'Type_or_Member'
11+
CS1712: Type parameter 'type_parameter' has no matching typeparam tag in the XML comment on 'type_or_member' (but other type parameters do)
12+
-->
13+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
14+
<NoWarn>$(NoWarn),1573,1591,1712</NoWarn>
15+
16+
<!--
17+
Suppress warnings for currently-invalid documentation comments.
18+
19+
CS1570: XML comment has badly formed XML
20+
CS1572: XML comment has a param tag, but there is no parameter by that name
21+
CS1587: XML comment is not placed on a valid language element
22+
CS1711: XML comment has a typeparam tag, but there is no type parameter by that name
23+
-->
24+
<NoWarn>$(NoWarn),1570,1572,1587,1711</NoWarn>
25+
</PropertyGroup>
26+
27+
</Project>

Directory.Build.targets

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Project>
3+
</Project>

0 commit comments

Comments
 (0)