diff --git a/collects/tests/utils/scribblings.scrbl b/collects/tests/utils/scribblings.scrbl new file mode 100644 index 0000000..e850931 --- /dev/null +++ b/collects/tests/utils/scribblings.scrbl @@ -0,0 +1,31 @@ +#lang scribble/doc + +@(require scribble/manual + (for-label racket)) + +@title{Internal Testing Utilities} + +@section{Checking documentation completeness} +@defmodule[tests/utils/docs-complete] + +@defproc[(check-docs [lib symbol?] + [#:skip skip + (or/c regexp? + symbol? + (listof (or/c regexp? symbol?)) + (-> symbol? any) + #f) + #f]) + any]{ + +Checks to see if the module path named by @racket[lib] (e.g. @racket['racket/list]) +has documented all of its exports and prints an error message to +@racket[(current-error-port)] if not. + +If @racket[skip] is a regexp, then exporting matching that regexp +are ignored. If it is a symbol, then that export is ignored. If +it is a list of symbols and regexps, then any exporting matching any of the +symbols or regexps are ignored. If it is a function, the function is treated +as a predicate and passed each export of the module. If @racket[skip] is +@racket[#f], no exports are skipped. +}