Improve documentation

lcartey · lcartey · commit 665a7d16c8c0 · 2025-02-18T16:50:33.000Z
diff --git a/cpp/common/src/codingstandards/cpp/deviations/CodeIdentifierDeviation.qll b/cpp/common/src/codingstandards/cpp/deviations/CodeIdentifierDeviation.qll
@@ -145,6 +145,8 @@ private predicate mkBeginStack(DeviationRecord record, File file, BeginStack sta
   // Stack is empty at the start
   index = 0 and
   stack = TEmptyBeginStack() and
+  // Only initialize when there is at least one such comment marker for this file and record
+  // pairing
   exists(CommentDeviationRangeMarker marker |
     marker.getRecord() = record and marker.getLocation().getFile() = file
   )

Original file line number	Diff line number	Diff line change
`@@ -145,6 +145,8 @@ private predicate mkBeginStack(DeviationRecord record, File file, BeginStack sta`
`145`	`145`	`// Stack is empty at the start`
`146`	`146`	`index = 0 and`
`147`	`147`	`stack = TEmptyBeginStack() and`
	`148`	`+ // Only initialize when there is at least one such comment marker for this file and record`
	`149`	`+ // pairing`
`148`	`150`	`exists(CommentDeviationRangeMarker marker \|`
`149`	`151`	`marker.getRecord() = record and marker.getLocation().getFile() = file`
`150`	`152`	`)`