Class rule31CommentSequences

MISRA Rule 3.1:

Hierarchy (view full)

MISRARule
- rule31CommentSequences

Index

Constructors

Properties

Methods

logMISRAError logMISRAWarning match transform

Constructors

constructor

new rule31CommentSequences(context): rule31CommentSequences
Parameters
- context: MISRAContext
Returns rule31CommentSequences
Overrides MISRARule.constructor
- Defined in rules/Section3_Comments/Rule_3_1_CommentSequences.ts:12

Properties

`Protected`context

context: MISRAContext

MISRA context for error tracking and rule transformations state

`Readonly`ruleID

ruleID: string

Unique identifier for the MISRA rule.

Methods

`Protected`logMISRAError

logMISRAError($jp, msg): void
Logs a MISRA-C rule violation error
Parameters
- $jp: Joinpoint
  The joinpoint where the violation occurred
- msg: string
  Description of the violation
Returns void
Inherited from MISRARule.logMISRAError
- Defined in MISRARule.ts:56

`Protected`logMISRAWarning

logMISRAWarning($jp, msg): void
Logs a warning from automatic MISRA-C correction, which may change the program's behavior
Parameters
- $jp: Joinpoint
  The joinpoint where the correction was applied
- msg: string
  Description of the warning
Returns void
Inherited from MISRARule.logMISRAWarning
- Defined in MISRARule.ts:70

match

match($jp, logErrors?): boolean
Checks if the joinpoint violates the rule
Parameters
- $jp: Joinpoint
  Joinpoint to analyze
- logErrors: boolean = false
  [logErrors=false] - Whether to log errors if a violation is detected
Returns boolean
Returns true if the joinpoint violates the rule, false otherwise
Overrides MISRARule.match
- Defined in rules/Section3_Comments/Rule_3_1_CommentSequences.ts:16

transform

transform($jp): MISRATransformationReport
Transforms the joinpoint to comply with the MISRA-C rule
Parameters
- $jp: Joinpoint
  Joinpoint to transform
Returns MISRATransformationReport
Report detailing the transformation result
Overrides MISRARule.transform
- Defined in rules/Section3_Comments/Rule_3_1_CommentSequences.ts:29