CPP: Add some comments to the QL.

geoffw0 · geoffw0 · commit 55465c3eae05 · 2018-10-29T16:39:49.000Z
diff --git a/cpp/ql/src/Best Practices/Likely Errors/EmptyBlock.ql b/cpp/ql/src/Best Practices/Likely Errors/EmptyBlock.ql
@@ -29,6 +29,10 @@ class AffectedFile extends File {
   }
 }
 
+/**
+ * A block, or an element we might find textually within a block that is
+ * not a child of it in the AST.
+ */
 class BlockOrNonChild extends Element {
   BlockOrNonChild() {
     ( this instanceof Block
@@ -68,6 +72,9 @@ class BlockOrNonChild extends Element {
   }
 }
 
+/**
+ * A block that contains a non-child element.
+ */
 predicate emptyBlockContainsNonchild(Block b) {
   emptyBlock(_, b) and
   exists(BlockOrNonChild c, AffectedFile file |
@@ -78,7 +85,12 @@ predicate emptyBlockContainsNonchild(Block b) {
   )
 }
 
+/**
+ * A block that is entirely on one line, which also contains a comment.  Chances
+ * are the comment is intended to refer to the block.
+ */
 predicate lineComment(Block b) {
+  emptyBlock(_, b) and
   exists(File f, int line |
     f = b.getFile() and
     line = b.getLocation().getStartLine() and

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,10 @@ class AffectedFile extends File {`
`29`	`29`	`}`
`30`	`30`	`}`
`31`	`31`
	`32`	`+/**`
	`33`	`+ * A block, or an element we might find textually within a block that is`
	`34`	`+ * not a child of it in the AST.`
	`35`	`+ */`
`32`	`36`	`class BlockOrNonChild extends Element {`
`33`	`37`	`BlockOrNonChild() {`
`34`	`38`	`( this instanceof Block`
`@@ -68,6 +72,9 @@ class BlockOrNonChild extends Element {`
`68`	`72`	`}`
`69`	`73`	`}`
`70`	`74`
	`75`	`+/**`
	`76`	`+ * A block that contains a non-child element.`
	`77`	`+ */`
`71`	`78`	`predicate emptyBlockContainsNonchild(Block b) {`
`72`	`79`	`emptyBlock(_, b) and`
`73`	`80`	`exists(BlockOrNonChild c, AffectedFile file \|`
`@@ -78,7 +85,12 @@ predicate emptyBlockContainsNonchild(Block b) {`
`78`	`85`	`)`
`79`	`86`	`}`
`80`	`87`
	`88`	`+/**`
	`89`	`+ * A block that is entirely on one line, which also contains a comment. Chances`
	`90`	`+ * are the comment is intended to refer to the block.`
	`91`	`+ */`
`81`	`92`	`predicate lineComment(Block b) {`
	`93`	`+ emptyBlock(_, b) and`
`82`	`94`	`exists(File f, int line \|`
`83`	`95`	`f = b.getFile() and`
`84`	`96`	`line = b.getLocation().getStartLine() and`