basis/xmode/highlight/highlight-docs.factor

   1 ! Copyright (C) 2011 John Benediktsson
   2 ! See https://factorcode.org/license.txt for BSD license
   3
   4 USING: help.markup help.syntax sequences strings words
   5 xmode.catalog xmode.highlight xmode.tokens ;
   6
   7 IN: xmode.highlight
   8
   9 HELP: highlight-tokens
  10 { $values { "tokens" sequence } }
  11 { $description
  12     "Highlight a sequence of " { $link token } " objects."
  13 } ;
  14
  15 HELP: highlight-lines
  16 { $values { "lines" sequence } { "mode" string } }
  17 { $description
  18     "Highlight lines of code, according to the specified " { $link mode }
  19     "."
  20 } ;
  21
  22 HELP: highlight.
  23 { $values { "obj" string } }
  24 { $description
  25     "Highlight and print code from the specified " { $link word } " or path (with a mode determined using the file extension)."
  26 } ;