extra/ctags/ctags-docs.factor

   1 USING: help.markup help.syntax vocabs ;
   2 IN: ctags
   3
   4 ARTICLE: "ctags" "Ctags file"
   5 { $emphasis "ctags" } " generates a index file of every factor word in ctags format as supported by vi and other editors. More information can be found at " { $url "http://en.wikipedia.org/wiki/Ctags" } "."
   6 { $subsections
   7     ctags
   8     write-ctags
   9 } ;
  10
  11 HELP: write-ctags
  12 { $values { "path" "a pathname string" } }
  13 { $description "Generates a index file in ctags format and stores in " { $snippet "path" } "." }
  14 { $examples
  15   { $unchecked-example
  16     "USING: ctags ;"
  17     "\"tags\" write-ctags"
  18     ""
  19   }
  20 } ;
  21
  22 HELP: ctags
  23 { $values { "ctags" "alist" } }
  24 { $description "Make a sequence of ctags from " { $link all-words } ", sorted by word name." } ;
  25
  26 ABOUT: "ctags"