basis/tools/scaffold/scaffold-docs.factor

   1 ! Copyright (C) 2008 Doug Coleman.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax kernel strings words ;
   4 IN: tools.scaffold
   5
   6 HELP: developer-name
   7 { $description "Set this symbol to hold your name so that the scaffold tools can generate the correct file header for copyright. Setting this variable in your .factor-boot-rc file is recommended." }
   8 { $code "USING: namespaces tools.scaffold ;\n\"Stacky Guy\" developer-name set-global" } ;
   9
  10 HELP: help.
  11 { $values
  12      { "word" word } }
  13 { $description "Prints out scaffold help markup for a given word." } ;
  14
  15 HELP: scaffold-help
  16 { $values { "string" string } }
  17 { $description "Takes an existing vocabulary and creates a help file with scaffolded help for each word. This word only works if no help file yet exists." } ;
  18
  19 HELP: scaffold-undocumented
  20 { $values
  21      { "string" string } }
  22 { $description "Prints scaffolding documenation for undocumented words in a vocabuary except for automatically generated class predicates." } ;
  23
  24 { scaffold-help scaffold-undocumented } related-words
  25
  26 HELP: scaffold-vocab
  27 { $values
  28      { "vocab-root" "a vocabulary root string" } { "string" string } }
  29 { $description "Creates a direcory in the given root for a new vocabulary and adds a main .factor file, a tests file, and an authors.txt file." } ;
  30
  31 HELP: using
  32 { $description "Stores the vocabularies that are pulled into the documentation file from looking up the stack effect types." } ;
  33
  34 ARTICLE: "tools.scaffold" "Scaffold tool"
  35 "Scaffold setup:"
  36 { $subsection developer-name }
  37 "Generate new vocabs:"
  38 { $subsection scaffold-vocab }
  39 "Generate help scaffolding:"
  40 { $subsection scaffold-help }
  41 { $subsection scaffold-undocumented }
  42 { $subsection help. }
  43 "Types that are unrecognized by the scaffold generator will be of type " { $link null } ". The developer should change these to strings that describe the stack effect names instead."
  44 ;
  45
  46 ABOUT: "tools.scaffold"