basis/stack-checker/backend/backend-docs.factor

   1 USING: compiler.tree effects help.markup help.syntax quotations sequences
   2 stack-checker.state stack-checker.visitor ;
   3 IN: stack-checker.backend
   4
   5 HELP: infer-quot-here
   6 { $values { "quot" quotation } }
   7 { $description "Performs inferencing on the given quotation. This word should only be called in a " { $link with-infer } " context." } ;
   8
   9 HELP: introduce-values
  10 { $values { "values" sequence } }
  11 { $description "Emits an " { $link #introduce } " node to the current " { $link stack-visitor } " which pushes the given values onto the data stack." } ;
  12
  13 HELP: with-infer
  14 { $values { "quot" quotation } { "effect" effect } { "visitor" "a visitor, if any" } }
  15 { $description "Initializes the inference engine and then runs the given quotation which is supposed to perform the inferencing." } ;
  16
  17 HELP: push-literal
  18 { $values { "obj" "something" } }
  19 { $description "Pushes a literal onto the " { $link literals } " sequence." } ;