Add docs for tools.coverage

diff --git a/basis/tools/coverage/coverage-docs.factor b/basis/tools/coverage/coverage-docs.factor
new file mode 100644 (file)
index 0000000..2964abb
--- /dev/null
+++ b/basis/tools/coverage/coverage-docs.factor
@@ -0,0 +1,45 @@
+! Copyright (C) 2011 Doug Coleman.
+! See http://factorcode.org/license.txt for BSD license.
+USING: help.markup help.syntax kernel sequences ;
+IN: tools.coverage
+
+HELP: <coverage>
+{ $values
+    { "executed?" boolean }
+    { "coverage" coverage }
+}
+{ $description "Makes a coverage tuple. Users should not call this directly." } ;
+
+HELP: coverage
+{ $values
+    { "object" object }
+    { "seq" sequence }
+}
+{ $description "Outputs a sequence of quotations that were not called since coverage tracking was enabled. If the input is a string, the output is an alist of word-name/quotations that were not used. If the input is a word name, the output is a sequence of quotations." } ;
+
+HELP: coverage-off
+{ $values
+    { "object" object }    
+}
+{ $description "Deactivates the coverage tool on a word or vocabulary." } ;
+
+HELP: coverage-on
+{ $values
+    { "object" object }    
+}
+{ $description "Activates the coverage tool on a word or vocabulary." } ;
+
+HELP: coverage.
+{ $values
+    { "object" object }    
+}
+{ $description "Calls the coverage word on all the words in a vocabalary or on a single word and prints out a report." } ;
+
+ARTICLE: "tools.coverage" "tools.coverage"
+"The " { $vocab-link "tools.coverage" } " vocabulary is a tool for testing code coverage. The implementation uses " { $vocab-link "tools.annotations" } " to place a coverage object at the beginning of every quotation. When the quotation executes, a slot on the coverage object is set to true. By examining the coverage objects after running the code for some time, one can see which of the quotations did not execute and write more tests or refactor the code." $nl
+"Enabling/disabling coverage:"
+{ $subsections coverage-on coverage-off }
+"Examining coverage data:"
+{ $subsections coverage coverage. } ;
+
+ABOUT: "tools.coverage"