Skip to content

Commit 49b4fe7

Browse files
committed
Add missing QLdoc
1 parent a1873cc commit 49b4fe7

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

ruby/ql/lib/codeql/ruby/InclusionTests.qll

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ class InclusionTest extends DataFlow::Node instanceof InclusionTest::Range {
3333
boolean getPolarity() { result = super.getPolarity() }
3434
}
3535

36+
/**
37+
* Contains classes for recognizing array and string inclusion tests.
38+
*/
3639
module InclusionTest {
3740
/**
3841
* A expression that is equivalent to `A.include?(B)` or `!A.include?(B)`.

ruby/ql/lib/codeql/ruby/StringOps.qll

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ private import codeql.ruby.DataFlow
77
private import codeql.ruby.controlflow.CfgNodes
88
private import InclusionTests
99

10+
/**
11+
* Provides classes for reasoning about string-manipulating expressions.
12+
*/
1013
module StringOps {
1114
/**
1215
* A expression that is equivalent to `A.start_with?(B)` or `!A.start_with?(B)`.
@@ -31,6 +34,9 @@ module StringOps {
3134
boolean getPolarity() { result = super.getPolarity() }
3235
}
3336

37+
/**
38+
* Provides classes implementing prefix test expressions.
39+
*/
3440
module StartsWith {
3541
/**
3642
* A expression that is equivalent to `A.start_with?(B)` or `!A.start_with?(B)`.
@@ -133,6 +139,9 @@ module StringOps {
133139
boolean getPolarity() { result = super.getPolarity() }
134140
}
135141

142+
/**
143+
* Provides classes implementing suffix test expressions.
144+
*/
136145
module EndsWith {
137146
/**
138147
* An expression that is equivalent to `A.end_with?(B)` or `!A.end_with?(B)`.

0 commit comments

Comments
 (0)