add missing qldoc

erik-krogh · erik-krogh · commit 2f9124f75406 · 2020-06-09T23:32:58.000+02:00
diff --git a/javascript/ql/src/semmle/javascript/security/dataflow/BuildArtifactLeak.qll b/javascript/ql/src/semmle/javascript/security/dataflow/BuildArtifactLeak.qll
@@ -9,6 +9,9 @@
 
 import javascript
 
+/**
+ * Classes and predicates for storage of sensitive information in build artifact query.
+ */
 module BuildArtifactLeak {
   import BuildArtifactLeakCustomizations::BuildArtifactLeak
   import CleartextLoggingCustomizations::CleartextLogging as CleartextLogging
@@ -27,7 +30,9 @@ module BuildArtifactLeak {
       sink.(Sink).getLabel() = lbl
     }
 
-    override predicate isSanitizer(DataFlow::Node node) { node instanceof CleartextLogging::Barrier }
+    override predicate isSanitizer(DataFlow::Node node) {
+      node instanceof CleartextLogging::Barrier
+    }
 
     override predicate isSanitizerEdge(DataFlow::Node pred, DataFlow::Node succ) {
       CleartextLogging::isSanitizerEdge(pred, succ)
diff --git a/javascript/ql/src/semmle/javascript/security/dataflow/BuildArtifactLeakCustomizations.qll b/javascript/ql/src/semmle/javascript/security/dataflow/BuildArtifactLeakCustomizations.qll
@@ -1,18 +1,23 @@
 /**
- * Provides default sources, sinks and sanitizers for reasoning about
- * storage of sensitive information in build artifact, as well as extension
- * points for adding your own.
+ * Provides default sinks for reasoning about storage of sensitive information
+ * in build artifact, as well as extension points for adding your own.
  */
 
 import javascript
 private import semmle.javascript.dataflow.InferredTypes
 private import semmle.javascript.security.SensitiveActions::HeuristicNames
 
+/**
+ * Sinks for storage of sensitive information in build artifact.
+ */
 module BuildArtifactLeak {
   /**
    * A data flow sink for clear-text logging of sensitive information.
    */
   abstract class Sink extends DataFlow::Node {
+    /**
+     * Gets a data-flow label that leaks information for this sink.
+     */
     DataFlow::FlowLabel getLabel() { result.isTaint() }
   }
 
