Skip to content

Commit 04d585e

Browse files
committed
Fix description in queries
1 parent bf9e9c7 commit 04d585e

20 files changed

+123
-1029
lines changed

cpp/common/src/codingstandards/cpp/exclusions/cpp/ImportMisra23.qll

Lines changed: 90 additions & 1008 deletions
Large diffs are not rendered by default.

cpp/misra/src/rules/DIR-5-7-2/SectionsOfCodeShouldNotBeCommentedOut.ql

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @id cpp/misra/sections-of-code-should-not-be-commented-out
33
* @name DIR-5-7-2: Sections of code should not be “commented out”
4-
* @description
4+
* @description Commented out code may become out of date leading to developer confusion.
55
* @kind problem
66
* @precision very-high
77
* @problem.severity error
@@ -16,7 +16,8 @@ import cpp
1616
import codingstandards.cpp.misra
1717
import codingstandards.cpp.rules.sectionsofcodeshallnotbecommentedout.SectionsOfCodeShallNotBeCommentedOut
1818

19-
class SectionsOfCodeShouldNotBeCommentedOutQuery extends SectionsOfCodeShallNotBeCommentedOutSharedQuery {
19+
class SectionsOfCodeShouldNotBeCommentedOutQuery extends SectionsOfCodeShallNotBeCommentedOutSharedQuery
20+
{
2021
SectionsOfCodeShouldNotBeCommentedOutQuery() {
2122
this = ImportMisra23Package::sectionsOfCodeShouldNotBeCommentedOutQuery()
2223
}

cpp/misra/src/rules/RULE-11-3-2/DeclarationOfAnObjectIndirectionsLevel.ql

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
/**
22
* @id cpp/misra/declaration-of-an-object-indirections-level
33
* @name RULE-11-3-2: The declaration of an object should contain no more than two levels of pointer indirection
4-
* @description
4+
* @description Declarations with more than two levels of pointer nesting can result in code that is
5+
* difficult to read and understand.
56
* @kind problem
67
* @precision very-high
78
* @problem.severity error

cpp/misra/src/rules/RULE-18-3-3/HandlersReferToNonStaticMembersFromTheirClass.ql

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* @id cpp/misra/handlers-refer-to-non-static-members-from-their-class
33
* @name RULE-18-3-3: Handlers for a function-try-block of a constructor or destructor shall not refer to non-static
44
* @description Handlers for a function-try-block of a constructor or destructor shall not refer to
5-
* non-static members from their class or its bases
5+
* non-static members from their class or its bases.
66
* @kind problem
77
* @precision very-high
88
* @problem.severity error

cpp/misra/src/rules/RULE-19-0-3/IncludeDirectivesPrecededByPreprocessorDirectives.ql

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
/**
22
* @id cpp/misra/include-directives-preceded-by-preprocessor-directives
33
* @name RULE-19-0-3: #include directives should only be preceded by preprocessor directives or comments
4-
* @description
4+
* @description Using anything other than other pre-processor directives or comments before an
5+
* '#include' directive makes the code more difficult to read.
56
* @kind problem
67
* @precision very-high
78
* @problem.severity error

cpp/misra/src/rules/RULE-19-1-3/IdentifiersUsedInTheControllingExpressionOf.ql

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* @id cpp/misra/identifiers-used-in-the-controlling-expression-of
33
* @name RULE-19-1-3: All identifiers used in the controlling expression of #if or #elif preprocessing directives shall be
44
* @description All identifiers used in the controlling expression of #if or #elif preprocessing
5-
* directives shall be defined prior to evaluation
5+
* directives shall be defined prior to evaluation.
66
* @kind problem
77
* @precision very-high
88
* @problem.severity error

cpp/misra/src/rules/RULE-19-2-3/CharsThatShouldNotOccurInHeaderFileName.ql

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* @id cpp/misra/chars-that-should-not-occur-in-header-file-name
33
* @name RULE-19-2-3: The ' or " or \ characters and the /* or // character sequences shall not occur in a header file
44
* @description The ' or " or \ characters and the /* or // character sequences shall not occur in a
5-
* header file name
5+
* header file name.
66
* @kind problem
77
* @precision very-high
88
* @problem.severity error

cpp/misra/src/rules/RULE-19-3-1/AndPreprocessorOperatorsShouldNotBeUsed.ql

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
/**
22
* @id cpp/misra/and-preprocessor-operators-should-not-be-used
33
* @name RULE-19-3-1: The # and ## preprocessor operators should not be used
4-
* @description
4+
* @description The order of evaluation for the '#' and '##' operators may differ between compilers,
5+
* which can cause unexpected behaviour.
56
* @kind problem
67
* @precision very-high
78
* @problem.severity error

cpp/misra/src/rules/RULE-19-3-5/TokensThatLookLikeDirectivesInAMacroArgument.ql

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
/**
22
* @id cpp/misra/tokens-that-look-like-directives-in-a-macro-argument
33
* @name RULE-19-3-5: Tokens that look like a preprocessing directive shall not occur within a macro argument
4-
* @description
4+
* @description Arguments to a function-like macro shall not contain tokens that look like
5+
* pre-processing directives or else behaviour after macro expansion is unpredictable.
56
* @kind problem
67
* @precision very-high
78
* @problem.severity error

cpp/misra/src/rules/RULE-21-6-5/PointerToAnIncompleteClassTypeDeleted.ql

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @id cpp/misra/pointer-to-an-incomplete-class-type-deleted
33
* @name RULE-21-6-5: A pointer to an incomplete class type shall not be deleted
4-
* @description
4+
* @description Do not delete pointers to incomplete classes to prevent undefined behavior.
55
* @kind problem
66
* @precision very-high
77
* @problem.severity error

0 commit comments

Comments
 (0)