Dataflow: Amend qldoc

Author: aschackmull

java/ql/lib/semmle/code/java/dataflow/internal/DataFlow.qll

@@ -66,6 +66,10 @@ signature module ConfigSig {
    * - `FeatureEqualSourceSinkCallContext`:
    *    Implies both of the above and additionally ensures that the entire flow
    *    path preserves the call context.
+   *
+   * These features are generally not relevant for typical end-to-end data flow
+   * queries, but should only be used for constructing paths that need to
+   * somehow be pluggable in another path context.
    */
   default FlowFeature getAFeature() { none() }
 
@@ -155,6 +159,10 @@ signature module StateConfigSig {
    * - `FeatureEqualSourceSinkCallContext`:
    *    Implies both of the above and additionally ensures that the entire flow
    *    path preserves the call context.
+   *
+   * These features are generally not relevant for typical end-to-end data flow
+   * queries, but should only be used for constructing paths that need to
+   * somehow be pluggable in another path context.
    */
   default FlowFeature getAFeature() { none() }
 

java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl.qll

@@ -84,6 +84,10 @@ signature module FullStateConfigSig {
    * - `FeatureEqualSourceSinkCallContext`:
    *    Implies both of the above and additionally ensures that the entire flow
    *    path preserves the call context.
+   *
+   * These features are generally not relevant for typical end-to-end data flow
+   * queries, but should only be used for constructing paths that need to
+   * somehow be pluggable in another path context.
    */
   FlowFeature getAFeature();
 

java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl1.qll

@@ -144,6 +144,10 @@ abstract class Configuration extends string {
    * - `FeatureEqualSourceSinkCallContext`:
    *    Implies both of the above and additionally ensures that the entire flow
    *    path preserves the call context.
+   *
+   * These features are generally not relevant for typical end-to-end data flow
+   * queries, but should only be used for constructing paths that need to
+   * somehow be pluggable in another path context.
    */
   FlowFeature getAFeature() { none() }
 

java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl2.qll

@@ -144,6 +144,10 @@ abstract class Configuration extends string {
    * - `FeatureEqualSourceSinkCallContext`:
    *    Implies both of the above and additionally ensures that the entire flow
    *    path preserves the call context.
+   *
+   * These features are generally not relevant for typical end-to-end data flow
+   * queries, but should only be used for constructing paths that need to
+   * somehow be pluggable in another path context.
    */
   FlowFeature getAFeature() { none() }
 

java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl3.qll

@@ -144,6 +144,10 @@ abstract class Configuration extends string {
    * - `FeatureEqualSourceSinkCallContext`:
    *    Implies both of the above and additionally ensures that the entire flow
    *    path preserves the call context.
+   *
+   * These features are generally not relevant for typical end-to-end data flow
+   * queries, but should only be used for constructing paths that need to
+   * somehow be pluggable in another path context.
    */
   FlowFeature getAFeature() { none() }
 

java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl4.qll

@@ -144,6 +144,10 @@ abstract class Configuration extends string {
    * - `FeatureEqualSourceSinkCallContext`:
    *    Implies both of the above and additionally ensures that the entire flow
    *    path preserves the call context.
+   *
+   * These features are generally not relevant for typical end-to-end data flow
+   * queries, but should only be used for constructing paths that need to
+   * somehow be pluggable in another path context.
    */
   FlowFeature getAFeature() { none() }
 

java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl5.qll

@@ -144,6 +144,10 @@ abstract class Configuration extends string {
    * - `FeatureEqualSourceSinkCallContext`:
    *    Implies both of the above and additionally ensures that the entire flow
    *    path preserves the call context.
+   *
+   * These features are generally not relevant for typical end-to-end data flow
+   * queries, but should only be used for constructing paths that need to
+   * somehow be pluggable in another path context.
    */
   FlowFeature getAFeature() { none() }
 

java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImpl6.qll

@@ -144,6 +144,10 @@ abstract class Configuration extends string {
    * - `FeatureEqualSourceSinkCallContext`:
    *    Implies both of the above and additionally ensures that the entire flow
    *    path preserves the call context.
+   *
+   * These features are generally not relevant for typical end-to-end data flow
+   * queries, but should only be used for constructing paths that need to
+   * somehow be pluggable in another path context.
    */
   FlowFeature getAFeature() { none() }
 

java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImplForOnActivityResult.qll

@@ -144,6 +144,10 @@ abstract class Configuration extends string {
    * - `FeatureEqualSourceSinkCallContext`:
    *    Implies both of the above and additionally ensures that the entire flow
    *    path preserves the call context.
+   *
+   * These features are generally not relevant for typical end-to-end data flow
+   * queries, but should only be used for constructing paths that need to
+   * somehow be pluggable in another path context.
    */
   FlowFeature getAFeature() { none() }
 

java/ql/lib/semmle/code/java/dataflow/internal/DataFlowImplForSerializability.qll

@@ -144,6 +144,10 @@ abstract class Configuration extends string {
    * - `FeatureEqualSourceSinkCallContext`:
    *    Implies both of the above and additionally ensures that the entire flow
    *    path preserves the call context.
+   *
+   * These features are generally not relevant for typical end-to-end data flow
+   * queries, but should only be used for constructing paths that need to
+   * somehow be pluggable in another path context.
    */
   FlowFeature getAFeature() { none() }