Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit aa28fdb

Browse files
aschackmullaschackmull
committed
Dataflow: Align some qldoc.
1 parent 0a4c680 commit aa28fdb

1 file changed

Lines changed: 29 additions & 31 deletions

File tree

‎java/ql/src/semmle/code/java/dataflow/internal/DataFlowImpl.qll‎

Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -808,13 +808,12 @@ private module Stage2 {
808808

809809
/* Begin: Stage 2 logic. */
810810
/**
811-
* Holds if `node` is reachable from a source in the configuration `config`.
812-
* The Boolean `ap` records whether the tracked value is stored into a
813-
* field of `node`.
811+
* Holds if `node` is reachable with access path `ap` from a source in the
812+
* configuration `config`.
814813
*
815-
* The Boolean `cc` records whether the node is reached through an
816-
* argument in a call, and if so, `argAp` records whether the tracked
817-
* value was stored into a field of the argument.
814+
* The call context `cc` records whether the node is reached through an
815+
* argument in a call, and if so, `argAp` records the access path of that
816+
* argument.
818817
*/
819818
private predicate fwdFlow(Node node, Cc cc, ApOption argAp, Ap ap, Configuration config) {
820819
flowCand(node, _, config) and
@@ -964,13 +963,12 @@ private module Stage2 {
964963
}
965964

966965
/**
967-
* Holds if `node` is part of a path from a source to a sink in the
968-
* configuration `config`. The Boolean `ap` records whether the tracked
969-
* value must be read from a field of `node` in order to reach a sink.
966+
* Holds if `node` with access path `ap` is part of a path from a source to a
967+
* sink in the configuration `config`.
970968
*
971-
* The Boolean `toReturn` records whether the node must be returned from
972-
* the enclosing callable in order to reach a sink, and if so, `returnAp`
973-
* records whether a field must be read from the returned value.
969+
* The Boolean `toReturn` records whether the node must be returned from the
970+
* enclosing callable in order to reach a sink, and if so, `returnAp` records
971+
* the access path of the returned value.
974972
*/
975973
pragma[nomagic]
976974
predicate revFlow(Node node, boolean toReturn, ApOption returnAp, Ap ap, Configuration config) {
@@ -1362,12 +1360,12 @@ private module Stage3 {
13621360

13631361
/* Begin: Stage 3 logic. */
13641362
/**
1365-
* Holds if `node` is reachable with access path front `ap` from a
1366-
* source in the configuration `config`.
1363+
* Holds if `node` is reachable with access path `ap` from a source in the
1364+
* configuration `config`.
13671365
*
1368-
* The Boolean `cc` records whether the node is reached through an
1369-
* argument in a call, and if so, `argAp` records the front of the
1370-
* access path of that argument.
1366+
* The call context `cc` records whether the node is reached through an
1367+
* argument in a call, and if so, `argAp` records the access path of that
1368+
* argument.
13711369
*/
13721370
pragma[nomagic]
13731371
predicate fwdFlow(Node node, Cc cc, ApOption argAp, Ap ap, Configuration config) {
@@ -1529,12 +1527,12 @@ private module Stage3 {
15291527
}
15301528

15311529
/**
1532-
* Holds if `node` with access path front `ap` is part of a path from a
1533-
* source to a sink in the configuration `config`.
1530+
* Holds if `node` with access path `ap` is part of a path from a source to a
1531+
* sink in the configuration `config`.
15341532
*
1535-
* The Boolean `toReturn` records whether the node must be returned from
1536-
* the enclosing callable in order to reach a sink, and if so, `returnAp`
1537-
* records the front of the access path of the returned value.
1533+
* The Boolean `toReturn` records whether the node must be returned from the
1534+
* enclosing callable in order to reach a sink, and if so, `returnAp` records
1535+
* the access path of the returned value.
15381536
*/
15391537
pragma[nomagic]
15401538
predicate revFlow(Node node, boolean toReturn, ApOption returnAp, Ap ap, Configuration config) {
@@ -1971,12 +1969,12 @@ private module Stage4 {
19711969

19721970
/* Begin: Stage 4 logic. */
19731971
/**
1974-
* Holds if `node` is reachable with approximate access path `ap` from a source
1975-
* in the configuration `config`.
1972+
* Holds if `node` is reachable with access path `ap` from a source in the
1973+
* configuration `config`.
19761974
*
19771975
* The call context `cc` records whether the node is reached through an
1978-
* argument in a call, and if so, `argAp` records the approximate access path
1979-
* of that argument.
1976+
* argument in a call, and if so, `argAp` records the access path of that
1977+
* argument.
19801978
*/
19811979
predicate fwdFlow(Node node, Cc cc, ApOption argAp, Ap ap, Configuration config) {
19821980
fwdFlow0(node, cc, argAp, ap, config) and
@@ -2154,12 +2152,12 @@ private module Stage4 {
21542152
}
21552153

21562154
/**
2157-
* Holds if `node` with approximate access path `ap` is part of a path from a
2158-
* source to a sink in the configuration `config`.
2155+
* Holds if `node` with access path `ap` is part of a path from a source to a
2156+
* sink in the configuration `config`.
21592157
*
2160-
* The Boolean `toReturn` records whether the node must be returned from
2161-
* the enclosing callable in order to reach a sink, and if so, `returnAp`
2162-
* records the approximate access path of the returned value.
2158+
* The Boolean `toReturn` records whether the node must be returned from the
2159+
* enclosing callable in order to reach a sink, and if so, `returnAp` records
2160+
* the access path of the returned value.
21632161
*/
21642162
pragma[nomagic]
21652163
predicate revFlow(Node node, boolean toReturn, ApOption returnAp, Ap ap, Configuration config) {

0 commit comments

Comments
 (0)