www

commit 43def558671afa992ebbea2437df27ed6f9b0682
parent 29ce20fe57995a9dd5019810f947f44222538484
Author: JackFirth <jackhfirth@gmail.com>
Date:   Sat, 21 Feb 2015 00:46:09 -0800

Add docs for all but tests

Diffstat:
M
doc-coverage/doc-coverage.scrbl
 | 
66
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--

1 file changed, 64 insertions(+), 2 deletions(-)
diff --git a/doc-coverage/doc-coverage.scrbl b/doc-coverage/doc-coverage.scrbl
@@ -24,6 +24,11 @@ source code: @url["https://github.com/jackfirth/doc-coverage"]
 
 @section{Basic Module Documentation Reflection}
 
+These primitives for examining module documentation information
+allow the construction of tests and reflection tools. They are
+implemented with Racket's native module reflection functions
+combined with Scribble's @racket[xref?] tables.
+
 @defproc[(has-docs? [mod symbol?] [binding symbol?]) boolean?]{
   Returns @racket[#t] if the module @racket[mod] provides
   @racket[binding] with documentation, and @racket[#f]
@@ -31,4 +36,62 @@ source code: @url["https://github.com/jackfirth/doc-coverage"]
   @examples[#:eval the-eval
     (has-docs? 'racket/list 'second)
     (has-docs? 'racket/match 'match-...-nesting)
-]}
-\ No newline at end of file
+]}
+
+@defproc[(module->all-exported-names [mod symbol?]) (list/c symbol?)]{
+  Returns a list of all bindings exported by @racket[mod].
+  Similar to @racket[module->exports], but provides no
+  phase level information and lists both value bindings
+  and syntax bindings.
+  @examples[#:eval the-eval
+    (module->all-exported-names 'racket/match)
+]}
+
+@defproc[(module->documented-exported-names [mod symbol?]) (list/c symbol?)]{
+  Returns a list of only the bindings exported by @racket[mod]
+  with Scribble documentation.
+  @examples[#:eval the-eval
+    (module->documented-exported-names 'racket/match)
+]}
+
+@defproc[(module->undocumented-exported-names [mod symbol?]) (list/c symbol?)]{
+  Returns a list of only the bindings exported by @racket[mod]
+  without Scribble documentation.
+  @examples[#:eval the-eval
+    (module->undocumented-exported-names 'racket/match)
+]}
+
+@section{Module Documentation Statistics}
+
+These procedures are simple numeric tools built on the core
+module documentation reflection functions.
+
+@defproc[(module-num-exports [mod symbol?]) exact-nonnegative-integer?]{
+  Returns the number of bindings exported by @racket[mod], as
+  determined by @racket[module->all-exported-names].
+  @examples[#:eval the-eval
+    (module-num-exports 'racket/match)
+    (module-num-exports 'racket/list)
+]}
+
+@defproc[(module-num-documented-exports [mod symbol?]) exact-nonnegative-integer?]{
+  Similar to @racket[module-num-exports], but only for documented
+  exports.
+  @examples[#:eval the-eval
+    (module-num-documented-exports 'racket/match)
+]}
+
+@defproc[(module-num-undocumented-exports [mod symbol?]) exact-nonnegative-integer?]{
+  Similar to @racket[module-num-exports], but only for undocumented
+  exports.
+  @examples[#:eval the-eval
+    (module-num-undocumented-exports 'racket/match)
+]}
+
+@defproc[(module-documentation-ratio [mod symbol?]) exact-nonnegative-number?]{
+  Returns the percentage of bindings in @racket[mod] that are
+  documented.
+  @examples[#:eval the-eval
+    (module-documentation-ratio 'racket/match)
+]}
+