Skip to content

Commit 95b640d

Browse files
committed
Resolve missing qldoc errors
Document some, make some private, and delete the needless modules surrounding the spring models.
1 parent 036733d commit 95b640d

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

java/ql/src/utils/GenerateFlowTestCase.qll

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/**
2+
* Test-case generator for flow summaries. See the accompanying `GenerateFlowTestCase.py` for full
3+
* documentation and usage information.
4+
*/
5+
16
import java
27
import semmle.code.java.dataflow.internal.DataFlowPrivate
38
import semmle.code.java.dataflow.ExternalFlow
@@ -9,6 +14,9 @@ import semmle.code.java.dataflow.internal.FlowSummaryImpl
914
* tests to generate. Rows specified here should also satisfy `SummaryModelCsv.row`.
1015
*/
1116
class TargetSummaryModelCsv extends Unit {
17+
/**
18+
* Holds if a test should be generated for `row`.
19+
*/
1220
abstract predicate row(string r);
1321
}
1422

@@ -163,7 +171,7 @@ Type getRootSourceDeclaration(Type t) {
163171
* from `input` to `output`). Usually there is one of these per CSV row (`row`), but there may be more if `row` describes more than one
164172
* override or overload of a particular method, or if the input or output specifications cover more than one argument.
165173
*/
166-
newtype TTestCase =
174+
private newtype TTestCase =
167175
MkTestCase(
168176
CallableToTest callable, SummaryComponentStack input, SummaryComponentStack output, string kind,
169177
string row
@@ -199,6 +207,9 @@ class TestCase extends TTestCase {
199207
baseOutput = output.drop(output.length() - 1)
200208
}
201209

210+
/**
211+
* Returns a representation of this test case's parameters suitable for debugging.
212+
*/
202213
string toString() {
203214
result =
204215
row + " / " + callable + " / " + input + " / " + output + " / " + baseInput + " / " +

0 commit comments

Comments
 (0)