Skip to content

Commit df4f117

Browse files
committed
Rust: QLDoc formatting.
1 parent 044d0a1 commit df4f117

File tree

2 files changed

+23
-19
lines changed

2 files changed

+23
-19
lines changed

rust/ql/lib/codeql/rust/dataflow/FlowSink.qll

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
*
44
* Flow sinks defined here feed into data flow configurations as follows:
55
*
6-
* data from `*.model.yml` | QL extensions of `FlowSink::Range`
7-
* v v
8-
* `FlowSink` (associated with a models-as-data `kind` string)
9-
* v
10-
* `sinkNode` predicate | other QL defined sinks, for example using concepts
11-
* v v
12-
* various `Sink` classes for specific data flow configurations <- extending `QuerySink`
6+
* ```text
7+
* data from *.model.yml | QL extensions of FlowSink::Range
8+
* v v
9+
* FlowSink (associated with a models-as-data kind string)
10+
* v
11+
* sinkNode predicate | other QL defined sinks, for example using concepts
12+
* v v
13+
* various Sink classes for specific data flow configurations <- extending QuerySink
14+
* ```
1315
*
1416
* New sinks should be defined using models-as-data, QL extensions of
1517
* `FlowSink::Range`, or concepts. Data flow configurations should use the

rust/ql/lib/codeql/rust/dataflow/FlowSource.qll

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,20 @@
44
* Flow sources defined here feed into the `ActiveThreatModelSource` class and
55
* ultimately reach data flow configurations as follows:
66
*
7-
* data from `*.model.yml` | QL extensions of `FlowSource::Range`
8-
* v v
9-
* `FlowSource` (associated with a models-as-data `kind` string)
10-
* v
11-
* `sourceNode` predicate | (theoretically other QL defined sources)
12-
* v v
13-
* `ThreatModelSource` (associated with a threat model source type)
14-
* v
15-
* `ActiveThreatModelSource` (just the enabled sources)
16-
* v
17-
* various `Source` classes for specific data flow configurations
18-
*
7+
* ```text
8+
* data from *.model.yml | QL extensions of FlowSource::Range
9+
* v v
10+
* FlowSource (associated with a models-as-data kind string)
11+
* v
12+
* sourceNode predicate | (theoretically other QL defined sources)
13+
* v v
14+
* ThreatModelSource (associated with a threat model source type)
15+
* v
16+
* ActiveThreatModelSource (just the enabled sources)
17+
* v
18+
* various Source classes for specific data flow configurations
19+
* ```
20+
1921
* New sources should be defined using models-as-data or QL extensions of
2022
* `FlowSource::Range`. Data flow configurations on the other hand should use
2123
* `ActiveThreatModelSource` to match sources enabled in the user

0 commit comments

Comments
 (0)