Added QLDoc

atorralba · atorralba · commit 09d96e65b81a · 2021-10-18T11:02:32.000+02:00
diff --git a/java/ql/src/Security/CWE/CWE-940/AndroidIntentRedirect.qhelp b/java/ql/src/Security/CWE/CWE-940/AndroidIntentRedirect.qhelp
@@ -0,0 +1,18 @@
+<!DOCTYPE qhelp PUBLIC "-//Semmle//qhelp//EN" "qhelp.dtd">
+<qhelp>
+    <overview>
+        <p></p>
+    </overview>
+    <recommendation>
+        <p></p>
+    </recommendation>
+    <example>
+        <p></p>
+        <sample src="" />
+    </example>
+    <references>
+        <li>
+            <a href=""></a>
+        </li>
+    </references>
+</qhelp>
diff --git a/java/ql/src/semmle/code/java/security/AndroidIntentRedirect.qll b/java/ql/src/semmle/code/java/security/AndroidIntentRedirect.qll
@@ -1,15 +1,28 @@
+/** Provides classes to reason about Androind Intent redirect vulnerabilities. */
+
 import java
 private import semmle.code.java.dataflow.DataFlow
 private import semmle.code.java.frameworks.android.Intent
 
+/**
+ * A sink for Intent redirect vulnerabilities in Android,
+ * that is, method calls that start Android components (like activities or services).
+ */
 abstract class IntentRedirectSink extends DataFlow::Node { }
 
+/** A sanitizer for data used to start an Android component. */
 abstract class IntentRedirectSanitizer extends DataFlow::Node { }
 
+/**
+ * A unit class for adding additional taint steps.
+ *
+ * Extend this class to add additional taint steps that should apply to `IntentRedirectConfiguration`.
+ */
 class IntentRedirectAdditionalTaintStep extends Unit {
   abstract predicate step(DataFlow::Node node1, DataFlow::Node node2);
 }
 
+/** Default sink for Intent redirect vulnerabilities. */
 private class DefaultIntentRedirectSink extends IntentRedirectSink {
   DefaultIntentRedirectSink() {
     exists(MethodAccess ma, Method m |
