Add missing QLdoc

aibaars · aibaars · commit 49b4fe77ad86 · 2022-03-07T17:59:06.000+01:00
diff --git a/ruby/ql/lib/codeql/ruby/InclusionTests.qll b/ruby/ql/lib/codeql/ruby/InclusionTests.qll
@@ -33,6 +33,9 @@ class InclusionTest extends DataFlow::Node instanceof InclusionTest::Range {
   boolean getPolarity() { result = super.getPolarity() }
 }
 
+/**
+ * Contains classes for recognizing array and string inclusion tests.
+ */
 module InclusionTest {
   /**
    * A expression that is equivalent to `A.include?(B)` or `!A.include?(B)`.
diff --git a/ruby/ql/lib/codeql/ruby/StringOps.qll b/ruby/ql/lib/codeql/ruby/StringOps.qll
@@ -7,6 +7,9 @@ private import codeql.ruby.DataFlow
 private import codeql.ruby.controlflow.CfgNodes
 private import InclusionTests
 
+/**
+ * Provides classes for reasoning about string-manipulating expressions.
+ */
 module StringOps {
   /**
    * A expression that is equivalent to `A.start_with?(B)` or `!A.start_with?(B)`.
@@ -31,6 +34,9 @@ module StringOps {
     boolean getPolarity() { result = super.getPolarity() }
   }
 
+  /**
+   * Provides classes implementing prefix test expressions.
+   */
   module StartsWith {
     /**
      * A expression that is equivalent to `A.start_with?(B)` or `!A.start_with?(B)`.
@@ -133,6 +139,9 @@ module StringOps {
     boolean getPolarity() { result = super.getPolarity() }
   }
 
+  /**
+   * Provides classes implementing suffix test expressions.
+   */
   module EndsWith {
     /**
      * An expression that is equivalent to `A.end_with?(B)` or `!A.end_with?(B)`.

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,9 @@ class InclusionTest extends DataFlow::Node instanceof InclusionTest::Range {`
`33`	`33`	`boolean getPolarity() { result = super.getPolarity() }`
`34`	`34`	`}`
`35`	`35`
	`36`	`+/**`
	`37`	`+ * Contains classes for recognizing array and string inclusion tests.`
	`38`	`+ */`
`36`	`39`	`module InclusionTest {`
`37`	`40`	`/**`
`38`	`41`	* A expression that is equivalent to `A.include?(B)` or `!A.include?(B)`.