Improve qldoc

smowton · smowton · commit 2a6e86633d99 · 2023-11-30T11:24:01.000Z
diff --git a/java/ql/lib/semmle/code/java/Statement.qll b/java/ql/lib/semmle/code/java/Statement.qll
@@ -514,7 +514,7 @@ class ConstCase extends SwitchCase {
   Expr getValue() { result.isNthChildOf(this, 0) }
 
   /**
-   * Gets the `case` constant at the specified index.
+   * Gets the `case` constant at index `i`.
    */
   Expr getValue(int i) { result.isNthChildOf(this, i) and i >= 0 }
 
diff --git a/java/ql/lib/semmle/code/java/dataflow/TypeFlow.qll b/java/ql/lib/semmle/code/java/dataflow/TypeFlow.qll
@@ -441,7 +441,7 @@ private predicate instanceOfGuarded(Expr e, RefType t) {
 }
 
 /**
- * Holds if `va` is an access to a value that is guarded by `case T t`.
+ * Holds if `e` is an access to a value that is guarded by `case T t`.
  */
 private predicate patternCaseGuarded(Expr e, RefType t) {
   exists(PatternCase pc |

Original file line number	Diff line number	Diff line change
`@@ -441,7 +441,7 @@ private predicate instanceOfGuarded(Expr e, RefType t) {`
`441`	`441`	`}`
`442`	`442`
`443`	`443`	`/**`
`444`		- * Holds if `va` is an access to a value that is guarded by `case T t`.
	`444`	+ * Holds if `e` is an access to a value that is guarded by `case T t`.
`445`	`445`	`*/`
`446`	`446`	`private predicate patternCaseGuarded(Expr e, RefType t) {`
`447`	`447`	`exists(PatternCase pc \|`