Fix description in queries

mbaluda · mbaluda · commit 04d585e1524c · 2024-05-16T17:55:43.000+02:00
diff --git a/cpp/common/src/codingstandards/cpp/exclusions/cpp/ImportMisra23.qll b/cpp/common/src/codingstandards/cpp/exclusions/cpp/ImportMisra23.qll
diff --git a/cpp/misra/src/rules/DIR-5-7-2/SectionsOfCodeShouldNotBeCommentedOut.ql b/cpp/misra/src/rules/DIR-5-7-2/SectionsOfCodeShouldNotBeCommentedOut.ql
@@ -1,7 +1,7 @@
 /**
  * @id cpp/misra/sections-of-code-should-not-be-commented-out
  * @name DIR-5-7-2: Sections of code should not be “commented out”
- * @description 
+ * @description Commented out code may become out of date leading to developer confusion.
  * @kind problem
  * @precision very-high
  * @problem.severity error
@@ -16,7 +16,8 @@ import cpp
 import codingstandards.cpp.misra
 import codingstandards.cpp.rules.sectionsofcodeshallnotbecommentedout.SectionsOfCodeShallNotBeCommentedOut
 
-class SectionsOfCodeShouldNotBeCommentedOutQuery extends SectionsOfCodeShallNotBeCommentedOutSharedQuery {
+class SectionsOfCodeShouldNotBeCommentedOutQuery extends SectionsOfCodeShallNotBeCommentedOutSharedQuery
+{
   SectionsOfCodeShouldNotBeCommentedOutQuery() {
     this = ImportMisra23Package::sectionsOfCodeShouldNotBeCommentedOutQuery()
   }
diff --git a/cpp/misra/src/rules/RULE-11-3-2/DeclarationOfAnObjectIndirectionsLevel.ql b/cpp/misra/src/rules/RULE-11-3-2/DeclarationOfAnObjectIndirectionsLevel.ql
@@ -1,7 +1,8 @@
 /**
  * @id cpp/misra/declaration-of-an-object-indirections-level
  * @name RULE-11-3-2: The declaration of an object should contain no more than two levels of pointer indirection
- * @description 
+ * @description Declarations with more than two levels of pointer nesting can result in code that is
+ *              difficult to read and understand.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-18-3-3/HandlersReferToNonStaticMembersFromTheirClass.ql b/cpp/misra/src/rules/RULE-18-3-3/HandlersReferToNonStaticMembersFromTheirClass.ql
@@ -2,7 +2,7 @@
  * @id cpp/misra/handlers-refer-to-non-static-members-from-their-class
  * @name RULE-18-3-3: Handlers for a function-try-block of a constructor or destructor shall not refer to non-static
  * @description Handlers for a function-try-block of a constructor or destructor shall not refer to
- *              non-static members from their class or its bases
+ *              non-static members from their class or its bases.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-19-0-3/IncludeDirectivesPrecededByPreprocessorDirectives.ql b/cpp/misra/src/rules/RULE-19-0-3/IncludeDirectivesPrecededByPreprocessorDirectives.ql
@@ -1,7 +1,8 @@
 /**
  * @id cpp/misra/include-directives-preceded-by-preprocessor-directives
  * @name RULE-19-0-3: #include directives should only be preceded by preprocessor directives or comments
- * @description 
+ * @description Using anything other than other pre-processor directives or comments before an
+ *              '#include' directive makes the code more difficult to read.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-19-1-3/IdentifiersUsedInTheControllingExpressionOf.ql b/cpp/misra/src/rules/RULE-19-1-3/IdentifiersUsedInTheControllingExpressionOf.ql
@@ -2,7 +2,7 @@
  * @id cpp/misra/identifiers-used-in-the-controlling-expression-of
  * @name RULE-19-1-3: All identifiers used in the controlling expression of #if or #elif preprocessing directives shall be
  * @description All identifiers used in the controlling expression of #if or #elif preprocessing
- *              directives shall be defined prior to evaluation
+ *              directives shall be defined prior to evaluation.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-19-2-3/CharsThatShouldNotOccurInHeaderFileName.ql b/cpp/misra/src/rules/RULE-19-2-3/CharsThatShouldNotOccurInHeaderFileName.ql
@@ -2,7 +2,7 @@
  * @id cpp/misra/chars-that-should-not-occur-in-header-file-name
  * @name RULE-19-2-3: The ' or " or \ characters and the /* or // character sequences shall not occur in a header file
  * @description The ' or " or \ characters and the /* or // character sequences shall not occur in a
- *              header file name
+ *              header file name.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-19-3-1/AndPreprocessorOperatorsShouldNotBeUsed.ql b/cpp/misra/src/rules/RULE-19-3-1/AndPreprocessorOperatorsShouldNotBeUsed.ql
@@ -1,7 +1,8 @@
 /**
  * @id cpp/misra/and-preprocessor-operators-should-not-be-used
  * @name RULE-19-3-1: The # and ## preprocessor operators should not be used
- * @description 
+ * @description The order of evaluation for the '#' and '##' operators may differ between compilers,
+ *              which can cause unexpected behaviour.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-19-3-5/TokensThatLookLikeDirectivesInAMacroArgument.ql b/cpp/misra/src/rules/RULE-19-3-5/TokensThatLookLikeDirectivesInAMacroArgument.ql
@@ -1,7 +1,8 @@
 /**
  * @id cpp/misra/tokens-that-look-like-directives-in-a-macro-argument
  * @name RULE-19-3-5: Tokens that look like a preprocessing directive shall not occur within a macro argument
- * @description 
+ * @description Arguments to a function-like macro shall not contain tokens that look like
+ *              pre-processing directives or else behaviour after macro expansion is unpredictable.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-21-6-5/PointerToAnIncompleteClassTypeDeleted.ql b/cpp/misra/src/rules/RULE-21-6-5/PointerToAnIncompleteClassTypeDeleted.ql
@@ -1,7 +1,7 @@
 /**
  * @id cpp/misra/pointer-to-an-incomplete-class-type-deleted
  * @name RULE-21-6-5: A pointer to an incomplete class type shall not be deleted
- * @description 
+ * @description Do not delete pointers to incomplete classes to prevent undefined behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-25-5-2/PointersReturnedByLocaleFunctionsMustBeUsedAsConst.ql b/cpp/misra/src/rules/RULE-25-5-2/PointersReturnedByLocaleFunctionsMustBeUsedAsConst.ql
@@ -3,8 +3,8 @@
  * @name RULE-25-5-2: The pointers returned by environment functions should be treated as const
  * @description The pointers returned by the C++ Standard Library functions localeconv, getenv,
  *              setlocale or strerror must only be used as if they have pointer to const-qualified
- *              type
- * @kind path-problem
+ *              type.
+ * @kind problem
  * @precision very-high
  * @problem.severity error
  * @tags external/misra/id/rule-25-5-2
diff --git a/cpp/misra/src/rules/RULE-28-6-3/ObjectUsedWhileInPotentiallyMovedFromState.ql b/cpp/misra/src/rules/RULE-28-6-3/ObjectUsedWhileInPotentiallyMovedFromState.ql
@@ -1,7 +1,7 @@
 /**
  * @id cpp/misra/object-used-while-in-potentially-moved-from-state
  * @name RULE-28-6-3: An object shall not be used while in a potentially moved-from state
- * @description 
+ * @description Moved-from object shall not be read-accessed.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-30-0-2/ReadsAndWritesOnStreamNotSeparatedByPositioning.ql b/cpp/misra/src/rules/RULE-30-0-2/ReadsAndWritesOnStreamNotSeparatedByPositioning.ql
@@ -1,7 +1,8 @@
 /**
  * @id cpp/misra/reads-and-writes-on-stream-not-separated-by-positioning
  * @name RULE-30-0-2: Reads and writes on the same file stream shall be separated by a positioning operation
- * @description 
+ * @description Alternate input and output operations on a file stream shall not be used without an
+ *              intervening flush or positioning call.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-6-2-1/OneDefinitionRuleViolated.ql b/cpp/misra/src/rules/RULE-6-2-1/OneDefinitionRuleViolated.ql
@@ -1,7 +1,8 @@
 /**
  * @id cpp/misra/one-definition-rule-violated
  * @name RULE-6-2-1: The one-definition rule shall not be violated
- * @description 
+ * @description The one-definition rule specifies when there should be a single definition of an
+ *              element and a violation of that rule leads to undefined behavior.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-6-4-1/VariableDeclaredInInnerScopeHidesOuterScope.ql b/cpp/misra/src/rules/RULE-6-4-1/VariableDeclaredInInnerScopeHidesOuterScope.ql
@@ -1,7 +1,9 @@
 /**
  * @id cpp/misra/variable-declared-in-inner-scope-hides-outer-scope
  * @name RULE-6-4-1: A variable declared in an inner scope shall not hide a variable declared in an outer scope
- * @description 
+ * @description Use of an identifier declared in an inner scope with an identical name to an
+ *              identifier in an outer scope can lead to inadvertent errors if the incorrect
+ *              identifier is modified.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-8-2-3/CastRemovesConstOrVolatileFromPointerOrReference.ql b/cpp/misra/src/rules/RULE-8-2-3/CastRemovesConstOrVolatileFromPointerOrReference.ql
@@ -2,7 +2,7 @@
  * @id cpp/misra/cast-removes-const-or-volatile-from-pointer-or-reference
  * @name RULE-8-2-3: A cast shall not remove any const or volatile qualification from the type accessed via a pointer or
  * @description A cast shall not remove any const or volatile qualification from the type accessed
- *              via a pointer or by reference
+ *              via a pointer or by reference.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-9-4-1/IfElseIfEndCondition.ql b/cpp/misra/src/rules/RULE-9-4-1/IfElseIfEndCondition.ql
@@ -1,7 +1,7 @@
 /**
  * @id cpp/misra/if-else-if-end-condition
  * @name RULE-9-4-1: All if 
- * @description All if ... else if constructs shall be terminated with an else statement
+ * @description All if ... else if constructs shall be terminated with an else statement.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-9-6-3/GotoShallJumpToLabelDeclaredLaterInTheFunction.ql b/cpp/misra/src/rules/RULE-9-6-3/GotoShallJumpToLabelDeclaredLaterInTheFunction.ql
@@ -1,7 +1,7 @@
 /**
  * @id cpp/misra/goto-shall-jump-to-label-declared-later-in-the-function
  * @name RULE-9-6-3: The goto statement shall jump to a label declared later in the function body
- * @description 
+ * @description Jumping back to an earlier section in the code can lead to accidental iterations.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-9-6-4/FunctionDeclaredWithTheNoreturnAttributeReturn.ql b/cpp/misra/src/rules/RULE-9-6-4/FunctionDeclaredWithTheNoreturnAttributeReturn.ql
@@ -1,7 +1,8 @@
 /**
  * @id cpp/misra/function-declared-with-the-noreturn-attribute-return
  * @name RULE-9-6-4: A function declared with the [[noreturn]] attribute shall not return
- * @description 
+ * @description A function with the [[noreturn]] attribute that returns leads to undefined
+ *              behaviour.
  * @kind problem
  * @precision very-high
  * @problem.severity error
diff --git a/cpp/misra/src/rules/RULE-9-6-5/NonVoidFunctionShallReturnAValueOnAllPaths.ql b/cpp/misra/src/rules/RULE-9-6-5/NonVoidFunctionShallReturnAValueOnAllPaths.ql
@@ -1,7 +1,9 @@
 /**
  * @id cpp/misra/non-void-function-shall-return-a-value-on-all-paths
  * @name RULE-9-6-5: A function with non-void return type shall return a value on all paths
- * @description 
+ * @description A function with non-void return type that does not exit via a return statement can
+ *              result in undefined behaviour. An exception to this rule is exiting via exception
+ *              handling.
  * @kind problem
  * @precision very-high
  * @problem.severity error
