Java: Fix QLDoc

joefarebrother · joefarebrother · commit f58ebad75690 · 2020-10-16T10:22:41.000+01:00
diff --git a/java/ql/src/semmle/code/java/frameworks/guava/Guava.qll b/java/ql/src/semmle/code/java/frameworks/guava/Guava.qll
@@ -1,3 +1,7 @@
+/**
+ * Definitions for tracking taint steps throught the Guava framework.
+ */
+
 import java
 private import Strings
 private import Splitter
@@ -10,7 +14,7 @@ abstract class GuavaTaintPropagationMethod extends Method {
   /**
    * Holds if this method propagates taint between the given source and sink.
    * `src` and `sink` are indicies of arguments to this method, or -1 to represent the qualifier.
-   * `sink` ca also be -2 to represent the return value.
+   * `sink` can also be -2 to represent the return value.
    */
   abstract predicate propagatesTaint(int src, int sink);
 }
diff --git a/java/ql/src/semmle/code/java/frameworks/guava/Joiner.qll b/java/ql/src/semmle/code/java/frameworks/guava/Joiner.qll
@@ -1,3 +1,7 @@
+/**
+ * Definitions for tracking taint steps through the methods of `com.google.common.base.Joiner`.
+ */
+
 import java
 import Guava
 
diff --git a/java/ql/src/semmle/code/java/frameworks/guava/Splitter.qll b/java/ql/src/semmle/code/java/frameworks/guava/Splitter.qll
@@ -1,3 +1,7 @@
+/**
+ * Definitions for tracking taint steps through the methods of `com.google.common.base.Splitter`.
+ */
+
 import java
 import Guava
 
diff --git a/java/ql/src/semmle/code/java/frameworks/guava/Strings.qll b/java/ql/src/semmle/code/java/frameworks/guava/Strings.qll
@@ -1,3 +1,7 @@
+/**
+ * Definitions for tracking taint steps through the methods of `com.google.common.base.Strings`.
+ */
+
 import java
 import Guava
 
