Skip to content

Commit 01d39db

Browse files
committed
Initialize repository
0 parents  commit 01d39db

65 files changed

Lines changed: 3743 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.codecov.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# https://docs.codecov.io/docs/codecov-yaml
2+
# https://github.com/codecov/support/wiki/Codecov-Yaml
3+
4+
coverage:
5+
status:
6+
project:
7+
default: false
8+
patch:
9+
default: false
10+
11+
comment:
12+
layout: "diff"
13+
14+
flags:
15+
production:
16+
paths:
17+
- DocumentationAnalyzers/DocumentationAnalyzers/
18+
- DocumentationAnalyzers/DocumentationAnalyzers.CodeFixes/
19+
test:
20+
paths:
21+
- DocumentationAnalyzers/DocumentationAnalyzers.Test/

.editorconfig

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
root = true
2+
3+
[*.cs]
4+
charset = utf-8-bom
5+
insert_final_newline = true
6+
indent_style = space
7+
indent_size = 4
8+
9+
# Sort using and Import directives with System.* appearing first
10+
dotnet_sort_system_directives_first = true
11+
12+
# Always use "this." and "Me." when applicable; let StyleCop Analyzers provide the warning and fix
13+
dotnet_style_qualification_for_field = true:none
14+
dotnet_style_qualification_for_property = true:none
15+
dotnet_style_qualification_for_method = true:none
16+
dotnet_style_qualification_for_event = true:none
17+
18+
# Use language keywords where applicable; let StyleCop Analyzers provide the warning and fix
19+
dotnet_style_predefined_type_for_locals_parameters_members = true:none
20+
dotnet_style_predefined_type_for_member_access = true:none
21+
22+
# Suggest more modern language features when available
23+
dotnet_style_object_initializer = true:none
24+
dotnet_style_collection_initializer = true:none
25+
dotnet_style_coalesce_expression = true:suggestion
26+
dotnet_style_null_propagation = true:suggestion
27+
dotnet_style_explicit_tuple_names = true:suggestion
28+
29+
# New line preferences
30+
csharp_new_line_before_open_brace = all
31+
csharp_new_line_before_else = true
32+
csharp_new_line_before_catch = true
33+
csharp_new_line_before_finally = true
34+
csharp_new_line_before_members_in_object_initializers = true
35+
csharp_new_line_before_members_in_anonymous_types = true
36+
csharp_new_line_within_query_expression_clauses = true
37+
38+
# Indentation preferences
39+
csharp_indent_block_contents = true
40+
csharp_indent_braces = false
41+
csharp_indent_case_contents = true
42+
csharp_indent_switch_labels = false
43+
csharp_indent_labels = flush_left
44+
45+
# Space preferences
46+
csharp_space_after_cast = false
47+
csharp_space_after_colon_in_inheritance_clause = true
48+
csharp_space_after_comma = true
49+
csharp_space_after_dot = false
50+
csharp_space_after_keywords_in_control_flow_statements = true
51+
csharp_space_after_semicolon_in_for_statement = true
52+
csharp_space_around_binary_operators = before_and_after
53+
csharp_space_around_declaration_statements = do_not_ignore
54+
csharp_space_before_colon_in_inheritance_clause = true
55+
csharp_space_before_comma = false
56+
csharp_space_before_dot = false
57+
csharp_space_before_open_square_brackets = false
58+
csharp_space_before_semicolon_in_for_statement = false
59+
csharp_space_between_empty_square_brackets = false
60+
csharp_space_between_method_call_empty_parameter_list_parentheses = false
61+
csharp_space_between_method_call_name_and_opening_parenthesis = false
62+
csharp_space_between_method_call_parameter_list_parentheses = false
63+
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
64+
csharp_space_between_method_declaration_name_and_open_parenthesis = false
65+
csharp_space_between_method_declaration_parameter_list_parentheses = false
66+
csharp_space_between_parentheses = false
67+
csharp_space_between_square_brackets = false
68+
69+
# Prefer "var" only where type is obvious; disable diagnostics since no firm policy is in place yet
70+
csharp_style_var_for_built_in_types = false:none
71+
csharp_style_var_when_type_is_apparent = true:none
72+
csharp_style_var_elsewhere = false:none
73+
74+
# Prefer method-like constructs to have a block body
75+
csharp_style_expression_bodied_methods = false:none
76+
csharp_style_expression_bodied_constructors = false:none
77+
csharp_style_expression_bodied_operators = false:none
78+
79+
# Prefer property-like constructs to have an expression-body
80+
csharp_style_expression_bodied_properties = true:none
81+
csharp_style_expression_bodied_indexers = true:none
82+
csharp_style_expression_bodied_accessors = true:none
83+
84+
# Suggest more modern language features when available
85+
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
86+
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
87+
csharp_style_inlined_variable_declaration = true:none
88+
csharp_style_throw_expression = true:none
89+
csharp_style_conditional_delegate_call = true:suggestion

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto

.gitignore

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Build output
2+
bin/
3+
obj/
4+
5+
# Artifacts of the IDE and build
6+
.vs/
7+
packages/
8+
*.suo
9+
*.user
10+
OpenCover.Reports/
11+
OpenCover.Symbols/
12+
.nuget/NuGet.exe
13+
build/nuget/
14+
*.log
15+
16+
# Visual Studio performance tools
17+
*.psess
18+
*.vsp
19+
*.vspx

.mailmap

Whitespace-only changes.

.nuget/packages.config

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<packages>
3+
<package id="Codecov" version="1.0.1" />
4+
<package id="Microsoft.DiaSymReader.Pdb2Pdb" version="1.1.0-beta1-62624-01" />
5+
<package id="OpenCover" version="4.6.519" />
6+
<package id="ReportGenerator" version="2.3.5.0" targetFramework="net452" />
7+
<package id="xunit.runner.console" version="2.1.0" targetFramework="net452" />
8+
</packages>

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Contributing
2+
3+
If you want to contribute code you can get started by looking for issues marked as
4+
[help wanted](https://github.com/DotNetAnalyzers/DocumentationAnalyzers/labels/help%20wanted).
5+
6+
You can also help by filing issues, participating in discussions and doing code review.
7+
8+
## Building
9+
10+
Visual Studio 2017 (Community Edition or higher) is required for building this repository.

DOCUMENTATION.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
DocumentationAnalyzers provides warnings that indicate documentation rule violations in C# code. The warnings are organized into rule areas. This section provides an explanation of each of the default DocumentationAnalyzers rules.
2+
3+
### Rule areas
4+
5+
### Additional documentation

DocumentationAnalyzers.sln

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
2+
Microsoft Visual Studio Solution File, Format Version 12.00
3+
# Visual Studio 15
4+
VisualStudioVersion = 15.0.26711.1
5+
MinimumVisualStudioVersion = 10.0.40219.1
6+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DocumentationAnalyzers", "DocumentationAnalyzers\DocumentationAnalyzers\DocumentationAnalyzers.csproj", "{A8F9D65E-7FCE-4B3B-984C-36AB446CA4DD}"
7+
EndProject
8+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DocumentationAnalyzers.CodeFixes", "DocumentationAnalyzers\DocumentationAnalyzers.CodeFixes\DocumentationAnalyzers.CodeFixes.csproj", "{D6361C01-DD4E-4886-A9DD-E47BD72B614E}"
9+
EndProject
10+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DocumentationAnalyzers.Test", "DocumentationAnalyzers\DocumentationAnalyzers.Test\DocumentationAnalyzers.Test.csproj", "{CC2315FA-F2E8-4931-BD23-0B88207C735C}"
11+
EndProject
12+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DocumentationAnalyzers.Test.CSharp7", "DocumentationAnalyzers\DocumentationAnalyzers.Test.CSharp7\DocumentationAnalyzers.Test.CSharp7.csproj", "{025F7981-5393-4E9E-A73C-9FACB58F920C}"
13+
EndProject
14+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DocumentationAnalyzers.Vsix", "DocumentationAnalyzers\DocumentationAnalyzers.Vsix\DocumentationAnalyzers.Vsix.csproj", "{CE6F326B-D3D7-4C8B-8D6C-DB1ECC859FF3}"
15+
EndProject
16+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DocumentationAnalyzers.Status.Generator", "DocumentationAnalyzers\DocumentationAnalyzers.Status.Generator\DocumentationAnalyzers.Status.Generator.csproj", "{5DFCF8C1-F80D-4305-9D68-79FB60869BB7}"
17+
EndProject
18+
Global
19+
GlobalSection(SolutionConfigurationPlatforms) = preSolution
20+
Debug|Any CPU = Debug|Any CPU
21+
Release|Any CPU = Release|Any CPU
22+
EndGlobalSection
23+
GlobalSection(ProjectConfigurationPlatforms) = postSolution
24+
{A8F9D65E-7FCE-4B3B-984C-36AB446CA4DD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
25+
{A8F9D65E-7FCE-4B3B-984C-36AB446CA4DD}.Debug|Any CPU.Build.0 = Debug|Any CPU
26+
{A8F9D65E-7FCE-4B3B-984C-36AB446CA4DD}.Release|Any CPU.ActiveCfg = Release|Any CPU
27+
{A8F9D65E-7FCE-4B3B-984C-36AB446CA4DD}.Release|Any CPU.Build.0 = Release|Any CPU
28+
{D6361C01-DD4E-4886-A9DD-E47BD72B614E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
29+
{D6361C01-DD4E-4886-A9DD-E47BD72B614E}.Debug|Any CPU.Build.0 = Debug|Any CPU
30+
{D6361C01-DD4E-4886-A9DD-E47BD72B614E}.Release|Any CPU.ActiveCfg = Release|Any CPU
31+
{D6361C01-DD4E-4886-A9DD-E47BD72B614E}.Release|Any CPU.Build.0 = Release|Any CPU
32+
{CC2315FA-F2E8-4931-BD23-0B88207C735C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
33+
{CC2315FA-F2E8-4931-BD23-0B88207C735C}.Debug|Any CPU.Build.0 = Debug|Any CPU
34+
{CC2315FA-F2E8-4931-BD23-0B88207C735C}.Release|Any CPU.ActiveCfg = Release|Any CPU
35+
{CC2315FA-F2E8-4931-BD23-0B88207C735C}.Release|Any CPU.Build.0 = Release|Any CPU
36+
{025F7981-5393-4E9E-A73C-9FACB58F920C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
37+
{025F7981-5393-4E9E-A73C-9FACB58F920C}.Debug|Any CPU.Build.0 = Debug|Any CPU
38+
{025F7981-5393-4E9E-A73C-9FACB58F920C}.Release|Any CPU.ActiveCfg = Release|Any CPU
39+
{025F7981-5393-4E9E-A73C-9FACB58F920C}.Release|Any CPU.Build.0 = Release|Any CPU
40+
{CE6F326B-D3D7-4C8B-8D6C-DB1ECC859FF3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
41+
{CE6F326B-D3D7-4C8B-8D6C-DB1ECC859FF3}.Debug|Any CPU.Build.0 = Debug|Any CPU
42+
{CE6F326B-D3D7-4C8B-8D6C-DB1ECC859FF3}.Release|Any CPU.ActiveCfg = Release|Any CPU
43+
{CE6F326B-D3D7-4C8B-8D6C-DB1ECC859FF3}.Release|Any CPU.Build.0 = Release|Any CPU
44+
{5DFCF8C1-F80D-4305-9D68-79FB60869BB7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
45+
{5DFCF8C1-F80D-4305-9D68-79FB60869BB7}.Debug|Any CPU.Build.0 = Debug|Any CPU
46+
{5DFCF8C1-F80D-4305-9D68-79FB60869BB7}.Release|Any CPU.ActiveCfg = Release|Any CPU
47+
{5DFCF8C1-F80D-4305-9D68-79FB60869BB7}.Release|Any CPU.Build.0 = Release|Any CPU
48+
EndGlobalSection
49+
GlobalSection(SolutionProperties) = preSolution
50+
HideSolutionNode = FALSE
51+
EndGlobalSection
52+
GlobalSection(ExtensibilityGlobals) = postSolution
53+
SolutionGuid = {B2EF44F9-62BB-4A35-99DB-199EF8F54A73}
54+
EndGlobalSection
55+
EndGlobal
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Project>
3+
4+
<PropertyGroup>
5+
<Description>An implementation of .NET documentation rules using the .NET Compiler Platform</Description>
6+
<Product>DocumentationAnalyzers</Product>
7+
<Company>Tunnel Vision Laboratories, LLC</Company>
8+
<Copyright>Copyright © Tunnel Vision Laboratories, LLC 2018</Copyright>
9+
<NeutralLanguage>en-US</NeutralLanguage>
10+
11+
<Version>1.0.0.0</Version>
12+
<FileVersion>1.0.0.0</FileVersion>
13+
<InformationalVersion>1.0.0-dev</InformationalVersion>
14+
</PropertyGroup>
15+
16+
<PropertyGroup>
17+
<LangVersion>7.2</LangVersion>
18+
<Features>strict</Features>
19+
</PropertyGroup>
20+
21+
<PropertyGroup Condition="'$(BuildingInsideVisualStudio)' != 'true'">
22+
<!-- Ideally this is always enabled, but that tends to hurt developer productivity -->
23+
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
24+
</PropertyGroup>
25+
26+
<PropertyGroup>
27+
<DebugType>portable</DebugType>
28+
<DebugSymbols>true</DebugSymbols>
29+
</PropertyGroup>
30+
31+
<PropertyGroup>
32+
<!--
33+
Make sure any documentation comments which are included in code get checked for syntax during the build, but do
34+
not report warnings for missing comments.
35+
36+
CS1573: Parameter 'parameter' has no matching param tag in the XML comment for 'parameter' (but other parameters do)
37+
CS1591: Missing XML comment for publicly visible type or member 'Type_or_Member'
38+
CS1712: Type parameter 'type_parameter' has no matching typeparam tag in the XML comment on 'type_or_member' (but other type parameters do)
39+
-->
40+
<GenerateDocumentationFile>True</GenerateDocumentationFile>
41+
<NoWarn>$(NoWarn),1573,1591,1712</NoWarn>
42+
</PropertyGroup>
43+
44+
<ItemGroup>
45+
<PackageReference Include="AsyncUsageAnalyzers" Version="1.0.0-alpha003" PrivateAssets="all" />
46+
<PackageReference Include="StyleCop.Analyzers" Version="1.1.0-beta009" PrivateAssets="all" />
47+
</ItemGroup>
48+
49+
<ItemGroup>
50+
<None Include="$(MSBuildThisFileDirectory)*.ruleset" Link="%(Filename)%(Extension)" />
51+
52+
<!-- Show launchSettings.json in the project if it exists. -->
53+
<None Include="$(AppDesignerFolder)\launchSettings.json" Condition="Exists('$(AppDesignerFolder)\launchSettings.json')" />
54+
</ItemGroup>
55+
56+
<ItemGroup>
57+
<AdditionalFiles Include="$(MSBuildThisFileDirectory)stylecop.json">
58+
<Link>stylecop.json</Link>
59+
</AdditionalFiles>
60+
</ItemGroup>
61+
62+
</Project>

0 commit comments

Comments
 (0)