Skip to content

Commit d802917

Browse files
authored
Merge pull request #3971 from Evangelink/rule-doc-template
Update rules documentation template
2 parents f48d374 + 627d49f commit d802917

19 files changed

+11466
-1054
lines changed

src/Microsoft.CodeAnalysis.Analyzers/Microsoft.CodeAnalysis.Analyzers.md

Lines changed: 547 additions & 44 deletions
Large diffs are not rendered by default.

src/Microsoft.CodeAnalysis.Analyzers/Microsoft.CodeAnalysis.Analyzers.sarif

Lines changed: 42 additions & 42 deletions
Large diffs are not rendered by default.

src/Microsoft.CodeAnalysis.BannedApiAnalyzers/Microsoft.CodeAnalysis.BannedApiAnalyzers.md

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,41 @@
1+
# Microsoft.CodeAnalysis.BannedApiAnalyzers
2+
3+
## [RS0030](https://github.com/dotnet/roslyn-analyzers/blob/master/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/BannedApiAnalyzers.Help.md): Do not used banned APIs
4+
5+
|Item|Value|
6+
|-|-|
7+
|Category|ApiDesign|
8+
|Enabled|True|
9+
|Severity|Warning|
10+
|CodeFix|False|
11+
12+
### Rule description
13+
14+
The symbol has been marked as banned in this project, and an alternate should be used instead.
15+
16+
## [RS0031](https://github.com/dotnet/roslyn-analyzers/blob/master/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/BannedApiAnalyzers.Help.md): The list of banned symbols contains a duplicate
17+
18+
|Item|Value|
19+
|-|-|
20+
|Category|ApiDesign|
21+
|Enabled|True|
22+
|Severity|Warning|
23+
|CodeFix|False|
24+
25+
### Rule description
26+
27+
The list of banned symbols contains a duplicate.
28+
29+
## RS0035: External access to internal symbols outside the restricted namespace(s) is prohibited
30+
31+
|Item|Value|
32+
|-|-|
33+
|Category|ApiDesign|
34+
|Enabled|True|
35+
|Severity|Error|
36+
|CodeFix|False|
37+
38+
### Rule description
39+
40+
RestrictedInternalsVisibleToAttribute enables a restricted version of InternalsVisibleToAttribute that limits access to internal symbols to those within specified namespaces. Each referencing assembly can only access internal symbols defined in the restricted namespaces that the referenced assembly allows.
141

2-
Rule ID | Title | Category | Enabled | Severity | CodeFix | Description |
3-
--------|-------|----------|---------|----------|---------|--------------------------------------------------------------------------------------------------------------|
4-
[RS0030](https://github.com/dotnet/roslyn-analyzers/blob/master/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/BannedApiAnalyzers.Help.md) | Do not used banned APIs | ApiDesign | True | Warning | False | The symbol has been marked as banned in this project, and an alternate should be used instead. |
5-
[RS0031](https://github.com/dotnet/roslyn-analyzers/blob/master/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/BannedApiAnalyzers.Help.md) | The list of banned symbols contains a duplicate | ApiDesign | True | Warning | False | The list of banned symbols contains a duplicate. |
6-
RS0035 | External access to internal symbols outside the restricted namespace(s) is prohibited | ApiDesign | True | Error | False | RestrictedInternalsVisibleToAttribute enables a restricted version of InternalsVisibleToAttribute that limits access to internal symbols to those within specified namespaces. Each referencing assembly can only access internal symbols defined in the restricted namespaces that the referenced assembly allows. |

0 commit comments

Comments
 (0)