Ruby: Add missing QL docs

hvitved · hvitved · commit b477a4cc81ba · 2022-09-13T20:00:22.000+02:00
diff --git a/ruby/ql/lib/codeql/ruby/DataFlow.qll b/ruby/ql/lib/codeql/ruby/DataFlow.qll
@@ -5,6 +5,10 @@
 
 import codeql.Locations
 
+/**
+ * Provides classes for performing local (intra-procedural) and
+ * global (inter-procedural) data flow analyses.
+ */
 module DataFlow {
   import codeql.ruby.dataflow.internal.DataFlowImpl
 }
diff --git a/ruby/ql/lib/codeql/ruby/ast/Erb.qll b/ruby/ql/lib/codeql/ruby/ast/Erb.qll
@@ -37,6 +37,7 @@ class ErbTemplate extends TTemplate, ErbAstNode {
 
   final override string getAPrimaryQlClass() { result = "ErbTemplate" }
 
+  /** Gets a child node, if any. */
   ErbAstNode getAChildNode() { toGenerated(result) = g.getChild(_) }
 }
 
diff --git a/ruby/ql/lib/codeql/ruby/ast/Expr.qll b/ruby/ql/lib/codeql/ruby/ast/Expr.qll
@@ -207,6 +207,7 @@ class BodyStmt extends StmtSequence, TBodyStmt {
     result = unique(Ensure s | toGenerated(s) = getBodyStmtChild(this, _))
   }
 
+  /** Holds if this block has an `ensure` block. */
   final predicate hasEnsure() { exists(this.getEnsure()) }
 
   override AstNode getAChild(string pred) {

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,10 @@`
`5`	`5`
`6`	`6`	`import codeql.Locations`
`7`	`7`
	`8`	`+/**`
	`9`	`+ * Provides classes for performing local (intra-procedural) and`
	`10`	`+ * global (inter-procedural) data flow analyses.`
	`11`	`+ */`
`8`	`12`	`module DataFlow {`
`9`	`13`	`import codeql.ruby.dataflow.internal.DataFlowImpl`
`10`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ class ErbTemplate extends TTemplate, ErbAstNode {`
`37`	`37`
`38`	`38`	`final override string getAPrimaryQlClass() { result = "ErbTemplate" }`
`39`	`39`
	`40`	`+ /** Gets a child node, if any. */`
`40`	`41`	`ErbAstNode getAChildNode() { toGenerated(result) = g.getChild(_) }`
`41`	`42`	`}`
`42`	`43`
Original file line number	Diff line number	Diff line change
`@@ -207,6 +207,7 @@ class BodyStmt extends StmtSequence, TBodyStmt {`
`207`	`207`	`result = unique(Ensure s \| toGenerated(s) = getBodyStmtChild(this, _))`
`208`	`208`	`}`
`209`	`209`
	`210`	+ /** Holds if this block has an `ensure` block. */
`210`	`211`	`final predicate hasEnsure() { exists(this.getEnsure()) }`
`211`	`212`
`212`	`213`	`override AstNode getAChild(string pred) {`