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 { $subsection etags }
   7 { $subsection etags-write }
   8 { $subsection etag-strings }
   9 { $subsection etag-header }
  10
  11 HELP: etags ( path -- )
  12 { $values { "path" string } }
  13 { $description "Generates a index file in etags format and stores in " { $snippet "path" } "." }
  14 { $examples
  15   { $unchecked-example
  16     "USING: ctags.etags ;"
  17     "\"ETAGS\" etags"
  18     ""
  19   }
  20 } ;
  21
  22 HELP: etags-write ( alist path -- )
  23 { $values { "alist" sequence }
  24           { "path" string } }
  25 { $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" }
  26 { $examples
  27   { $unchecked-example
  28     "USING: kernel etags.ctags ;"
  29     "{ { \"resource:extra/unix/unix.factor\" V{ { dup2 91 } } } } \"ETAGS\" etags-write"
  30     ""
  31   }
  32 } ;
  33
  34 HELP: etag-strings ( alist -- seq )
  35 { $values { "alist" sequence }
  36           { "seq" sequence } }
  37 { $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." } ;
  38
  39 ABOUT: "etags" ;