From 27b97b0172c88305b245f72956cde456b8eada26 Mon Sep 17 00:00:00 2001
From: Doug Coleman <doug.coleman@gmail.com>
Date: Thu, 4 Sep 2008 01:50:26 -0500
Subject: [PATCH] make a word private, docs

---
 basis/tools/scaffold/scaffold-docs.factor | 47 +++++++++++++++++++++++
 basis/tools/scaffold/scaffold.factor      |  2 +-
 2 files changed, 48 insertions(+), 1 deletion(-)
 create mode 100644 basis/tools/scaffold/scaffold-docs.factor

diff --git a/basis/tools/scaffold/scaffold-docs.factor b/basis/tools/scaffold/scaffold-docs.factor
new file mode 100644
index 0000000000..e22e10f8c9
--- /dev/null
+++ b/basis/tools/scaffold/scaffold-docs.factor
@@ -0,0 +1,47 @@
+! Copyright (C) 2008 Doug Coleman.
+! See http://factorcode.org/license.txt for BSD license.
+USING: help.markup help.syntax kernel strings words ;
+IN: tools.scaffold
+
+HELP: developer-name
+{ $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." }
+{ $unchecked-example "USING: namespaces tools.scaffold ;\n\"Stacky Guy\" developer-name set-global" } ;
+
+HELP: help.
+{ $values
+     { "word" word } }
+{ $description "Prints out scaffold help markup for a given word." } ;
+
+HELP: scaffold-help
+{ $values
+     { "vocab-root" "a vocabulary root string" } { "string" string } }
+{ $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." } ;
+
+HELP: scaffold-undocumented
+{ $values
+     { "string" string } }
+{ $description "Prints scaffolding documenation for undocumented words in a vocabuary except for automatically generated class predicates." } ;
+
+{ scaffold-help scaffold-undocumented } related-words
+
+HELP: scaffold-vocab
+{ $values
+     { "vocab-root" "a vocabulary root string" } { "string" string } }
+{ $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." } ;
+
+HELP: using
+{ $description "Stores the vocabularies that are pulled into the documentation file from looking up the stack effect types." } ;
+
+ARTICLE: "tools.scaffold" "Scaffold tool"
+"Scaffold setup:"
+{ $subsection developer-name }
+"Generate new vocabs:"
+{ $subsection scaffold-vocab }
+"Generate help scaffolding:"
+{ $subsection scaffold-help }
+{ $subsection scaffold-undocumented }
+{ $subsection help. }
+"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."
+;
+
+ABOUT: "tools.scaffold"
diff --git a/basis/tools/scaffold/scaffold.factor b/basis/tools/scaffold/scaffold.factor
index dc7e21bc39..50e02b93a5 100644
--- a/basis/tools/scaffold/scaffold.factor
+++ b/basis/tools/scaffold/scaffold.factor
@@ -15,10 +15,10 @@ ERROR: vocab-name-contains-separator path ;
 ERROR: vocab-name-contains-dot path ;
 ERROR: no-vocab vocab ;
 
+<PRIVATE
 : root? ( string -- ? )
     vocab-roots get member?  ;
 
-<PRIVATE
 : check-vocab-name ( string -- string )
     dup dup [ CHAR: . = ] trim [ length ] bi@ =
     [ vocab-name-contains-dot ] unless