Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MattFromRVA committed Jun 18, 2024
1 parent 29514d2 commit 400f970
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions documentation/SA1642.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,23 @@ private Customer()
}
```

The `<para>` tag can be used within the `<summary>` tag to structure the text.
For example:

```csharp
/// <summary>
/// <para>
/// Initializes a new instance of the <see cref="Customer"/> class.
/// </para>
/// <para>
/// Additional information can be included in subsequent paragraphs.
/// </para>
/// </summary>
public Customer()
{
}
```

## How to fix violations

To fix a violation of this rule, edit the summary text for the constructor as described above.
Expand Down

0 comments on commit 400f970

Please sign in to comment.