basis/compiler/cfg/dataflow-analysis/dataflow-analysis-docs.factor

   1 USING: compiler.cfg help.markup help.syntax ;
   2 IN: compiler.cfg.dataflow-analysis
   3
   4 <PRIVATE
   5
   6 HELP: run-dataflow-analysis
   7 { $values
   8   { "cfg" cfg }
   9   { "dfa" "a dataflow analysis symbol" }
  10   { "in-sets" "inputs" }
  11   { "out-sets" "outputs" }
  12 }
  13 { $description "Runs the given dataflow analysis on the cfg." } ;
  14
  15 PRIVATE>
  16
  17 HELP: FORWARD-ANALYSIS:
  18 { $syntax "FORWARD-ANALYSIS: word" }
  19 { $values { "word" "name of the compiler pass" } }
  20 { $description "Syntax word for defining a forward analysis compiler pass." } ;
  21
  22 HELP: BACKWARD-ANALYSIS:
  23 { $syntax "BACKWARD-ANALYSIS: word" }
  24 { $values { "word" "name of the compiler pass" } }
  25 { $description "Syntax word for defining a backward analysis compiler pass." } ;