Skip to content

Commit 6239946

Browse files
Corrected SA1604 documentation to include a relevant example
#3848
1 parent ac00d09 commit 6239946

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

documentation/SA1604.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,10 @@ A violation of this rule occurs when the element documentation is missing a `<su
2929

3030
To fix a violation of this rule, add and fill-in a `<summary>` tag for the element, containing a description of the element.
3131

32-
The following example shows a class containing invalid Xml within its documentation header. The closing tag for the `<summary>` node is invalid.
32+
The following example shows a class containing a documentation header without a summary.
3333

3434
```csharp
35-
/// <summary>
36-
/// Represents a customer in the database.
37-
/// </summary>
35+
/// <remarks>A remark.</remarks>
3836
public class Customer
3937
{
4038
}

0 commit comments

Comments
 (0)