From 62399467292c94e813a18bacdd6d46e68b2d1f8f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Hellander?= Date: Wed, 29 May 2024 21:43:03 +0200 Subject: [PATCH] Corrected SA1604 documentation to include a relevant example #3848 --- documentation/SA1604.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/documentation/SA1604.md b/documentation/SA1604.md index 768b20dc2..8d3b75374 100644 --- a/documentation/SA1604.md +++ b/documentation/SA1604.md @@ -29,12 +29,10 @@ A violation of this rule occurs when the element documentation is missing a `` tag for the element, containing a description of the element. -The following example shows a class containing invalid Xml within its documentation header. The closing tag for the `` node is invalid. +The following example shows a class containing a documentation header without a summary. ```csharp -/// -/// Represents a customer in the database. -/// +/// A remark. public class Customer { }