extra/ctags/etags/etags-docs.factor

   1 USING: help.syntax help.markup kernel prettyprint sequences strings words math ;
   2 IN: ctags.etags
   3
   4 ARTICLE: "etags" "Etags file"
   5 { $emphasis "Etags" } " generates a index file of every factor word in etags format as supported by emacs and other editors. More information can be found at " { $url "http://en.wikipedia.org/wiki/Ctags#Etags_2" } "."
   6 { $subsections
   7     etags
   8     etags-write
   9     etag-strings
  10     etag-header
  11 }
  12
  13 HELP: etags ( path -- )
  14 { $values { "path" string } }
  15 { $description "Generates a index file in etags format and stores in " { $snippet "path" } "." }
  16 { $examples
  17   { $unchecked-example
  18     "USING: ctags.etags ;"
  19     "\"ETAGS\" etags"
  20     ""
  21   }
  22 } ;
  23
  24 HELP: etags-write ( alist path -- )
  25 { $values { "alist" sequence }
  26           { "path" string } }
  27 { $description "Stores a " { $snippet "alist" } " in " { $snippet "path" } ". " { $snippet "alist" } " must be an association list with etags format: its key must be a resource path and its value a vector, containing pairs of words and lines" }
  28 { $examples
  29   { $unchecked-example
  30     "USING: kernel etags.ctags ;"
  31     "{ { \"resource:extra/unix/unix.factor\" V{ { dup2 91 } } } } \"ETAGS\" etags-write"
  32     ""
  33   }
  34 } ;
  35
  36 HELP: etag-strings ( alist -- seq )
  37 { $values { "alist" sequence }
  38           { "seq" sequence } }
  39 { $description "Converts an " { $snippet "alist" } " with etag format (a path as key and a vector containing word/line pairs) in a " { $snippet "seq" } " of strings." } ;
  40
  41 ABOUT: "etags" ;