You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/list-of-diagnostics.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# List of Diagnostics Produced by Windows Forms .NET
2
2
3
-
We have 3 kinds of diagnostic messages: obsoletions, code analyzer diagnostics, and experimental feature compiler errors.
3
+
We have three kinds of diagnostic messages: obsoletions, code analyzer diagnostics, and experimental feature compiler errors.
4
4
5
5
## Obsoletions
6
6
@@ -11,12 +11,12 @@ The diagnostic ID values reserved for obsoletions are `WFDEV001` through `WFDEV9
11
11
### Acceptance Criteria for Adding an Obsoletion
12
12
13
13
1.**Add the obsoletion to the table below**, claiming the next diagnostic ID.
14
-
- Ensure the description is meaningful within the context of this table, and without requiring the context of the calling code.
14
+
- Ensure the description is meaningful within the context of this table and without requiring the context of the calling code.
15
15
2.**Add new constants to `src\Common\src\Obsoletions.cs`**, following the existing conventions:
16
16
- A `...Message` const using the same description added to the table below.
17
17
- A `...DiagnosticId` const for the `WFDEV###` ID.
18
-
3.**If adding `<Obsolete>` attribute to Microsoft.VisualBasic.Forms assembly**, edit `src\Microsoft.VisualBasic.Forms\src\Obsoletions.vb` file.
19
-
4.**Annotate `src` files by referring to the constants defined from`Obsoletions.cs`**:
18
+
3.**If adding the `<Obsolete>` attribute to the Microsoft.VisualBasic.Forms assembly**, edit the`src\Microsoft.VisualBasic.Forms\src\Obsoletions.vb` file.
19
+
4.**Annotate `src` files by referring to the constants defined in`Obsoletions.cs`**:
20
20
- Specify the `UrlFormat = Obsoletions.SharedUrlFormat`.
21
21
- Example:
22
22
```C#
@@ -30,15 +30,15 @@ The diagnostic ID values reserved for obsoletions are `WFDEV001` through `WFDEV9
-Pointittorepo's `.md` file in the `docs` folder that describes your analyzer until the `learn` site docs are completed in the [redirection manager](https://akalinkmanager.trafficmanager.net/am/redirection/home)
34
-
-Setsecuritygrouptotheteamalias
33
+
-Pointittotherepo's `.md` file in the `docs` folder that describes your analyzer until the `learn` site docs are completed in the [redirection manager](https://akalinkmanager.trafficmanager.net/am/redirection/home)
-Inthebreaking-changeissuefiledin [dotnet/docs](https://github.com/dotnet/docs), specifically mention that this breaking change is an obsoletion with a `WFDEV` diagnostic ID.
-ThedocumentationteamwillproduceaPRthataddsthewarningorerrordocumentationtothe ["learn"site](https://learn.microsoft.com/dotnet/desktop/winforms/wfdev-diagnostics/wfdev003) page and we will review it.
-ThedocumentationteamwillproduceaPRthataddsthewarningorerrordocumentationtothe [`learn`site](https://learn.microsoft.com/dotnet/desktop/winforms/wfdev-diagnostics/wfdev003) page, and we will review it.
@@ -60,16 +60,16 @@ The diagnostic ID values reserved for obsoletions are `WFDEV001` through `WFDEV9
60
60
| `WFDEV006` |NET10.0| `StatusBar` isprovidedforbinarycompatibilitywith .NETFrameworkandisnotintendedtobeuseddirectlyfromyourcode. Use `StatusStrip` instead. |
61
61
| `WFDEV006` |NET10.0| `ToolBar` isprovidedforbinarycompatibilitywith .NETFrameworkandisnotintendedtobeuseddirectlyfromyourcode. Use `ToolStrip` instead. |
62
62
63
-
## Analyzer Diagnostics.
63
+
## Analyzer Diagnostics
64
64
65
65
### When adding a new analyzer
66
66
67
67
1. **AddthediagnosticIDtothetablebelow**.
68
-
-ThecurrentIDsforC#, VBandlanguage-agnosticanalyzersaredefinedin [DiagnosticIDs.cs](https://github.com/dotnet/winforms/blob/main/src/System.Windows.Forms.Analyzers/src/System/Windows/Forms/Analyzers/Diagnostics/DiagnosticIDs.cs). Complete list of IDs, including those that were shipped and then replaced, is available in the `AnalyzerReleases.Shipped.md` and `AnalyzerReleases.Unshipped.md` files.
-ThecurrentIDsforC#, VB,andlanguage-agnosticanalyzersaredefinedin [DiagnosticIDs.cs](https://github.com/dotnet/winforms/blob/main/src/System.Windows.Forms.Analyzers/src/System/Windows/Forms/Analyzers/Diagnostics/DiagnosticIDs.cs). A complete list of IDs, including those that were shipped and then replaced, is available in the `AnalyzerReleases.Shipped.md` and `AnalyzerReleases.Unshipped.md` files.
-ThecurrentIDsforC#, VBandlanguage-agnosticanalyzersaredefinedin [DiagnosticIDs.cs](https://github.com/dotnet/winforms/blob/main/src/System.Windows.Forms.Analyzers/src/System/Windows/Forms/Analyzers/Diagnostics/DiagnosticIDs.cs). Complete list of IDs, including those that were shipped and then replaced, is available in the `AnalyzerReleases.Shipped.md` and `AnalyzerReleases.Unshipped.md` files.
0 commit comments