Apply qldoc suggestions

rvermeulen · aschackmull · web-flow · commit 2bdd3d771218 · 2020-08-31T17:28:51.000+02:00
Co-authored-by: Anders Schack-Mulligen &lt;aschackmull@users.noreply.github.com&gt;
diff --git a/java/ql/src/semmle/code/java/security/XSS.qll b/java/ql/src/semmle/code/java/security/XSS.qll
@@ -23,7 +23,7 @@ abstract class XssSanitizer extends DataFlow::Node { }
 abstract class XssAdditionalTaintStep extends TaintTracking2::Unit {
   /**
    * Holds if the step from `node1` to `node2` should be considered a taint
-   * step for all configurations.
+   * step for XSS taint configurations.
    */
   abstract predicate step(DataFlow::Node node1, DataFlow::Node node2);
 }
@@ -119,7 +119,7 @@ private class ServletWriterSourceToWritingMethodFlowConfig extends TaintTracking
   }
 }
 
-/** A class representing methods that can be used to output data. */
+/** A method that can be used to output data to an output stream or writer. */
 private class WritingMethod extends Method {
   WritingMethod() {
     getDeclaringType().getASupertype*().hasQualifiedName("java.io", _) and
@@ -131,7 +131,7 @@ private class WritingMethod extends Method {
   }
 }
 
-/** A class representing methods that provides access to an output stream or writer. */
+/** An output stream or writer that writes to a servlet response. */
 class ServletWriterSource extends MethodAccess {
   ServletWriterSource() {
     this.getMethod() instanceof ServletResponseGetWriterMethod

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ abstract class XssSanitizer extends DataFlow::Node { }`
`23`	`23`	`abstract class XssAdditionalTaintStep extends TaintTracking2::Unit {`
`24`	`24`	`/**`
`25`	`25`	* Holds if the step from `node1` to `node2` should be considered a taint
`26`		`- * step for all configurations.`
	`26`	`+ * step for XSS taint configurations.`
`27`	`27`	`*/`
`28`	`28`	`abstract predicate step(DataFlow::Node node1, DataFlow::Node node2);`
`29`	`29`	`}`
`@@ -119,7 +119,7 @@ private class ServletWriterSourceToWritingMethodFlowConfig extends TaintTracking`
`119`	`119`	`}`
`120`	`120`	`}`
`121`	`121`
`122`		`-/** A class representing methods that can be used to output data. */`
	`122`	`+/** A method that can be used to output data to an output stream or writer. */`
`123`	`123`	`private class WritingMethod extends Method {`
`124`	`124`	`WritingMethod() {`
`125`	`125`	`getDeclaringType().getASupertype*().hasQualifiedName("java.io", _) and`
`@@ -131,7 +131,7 @@ private class WritingMethod extends Method {`
`131`	`131`	`}`
`132`	`132`	`}`
`133`	`133`
`134`		`-/** A class representing methods that provides access to an output stream or writer. */`
	`134`	`+/** An output stream or writer that writes to a servlet response. */`
`135`	`135`	`class ServletWriterSource extends MethodAccess {`
`136`	`136`	`ServletWriterSource() {`
`137`	`137`	`this.getMethod() instanceof ServletResponseGetWriterMethod`