Skip to content

Commit 135d102

Browse files
committed
Add missing QLDoc
1 parent ed554f2 commit 135d102

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

‎go/ql/lib/semmle/go/dataflow/SsaImpl.qll‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,10 +184,17 @@ private module DataFlowIntegrationInput implements Impl::DataFlowIntegrationInpu
184184

185185
private module DataFlowIntegrationImpl = Impl::DataFlowIntegration<DataFlowIntegrationInput>;
186186

187+
/** Provides shared SSA nodes and local flow steps for Go data-flow analysis. */
187188
cached
188189
module DataFlowIntegration {
189190
import DataFlowIntegrationImpl
190191

192+
/**
193+
* Holds if the value of `v` flows from `nodeFrom` to `nodeTo` in one local SSA step.
194+
*
195+
* `isUseStep` is `true` when `nodeFrom` is a (post-update) read node and
196+
* `nodeTo` is a read node or phi (read) node.
197+
*/
191198
cached
192199
predicate localFlowStep(SsaSourceVariable v, Node nodeFrom, Node nodeTo, boolean isUseStep) {
193200
DataFlowIntegrationImpl::localFlowStep(v, nodeFrom, nodeTo, isUseStep)

0 commit comments

Comments
 (0)