suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix documentation to avoid drdr warnings.

Browse Source
This commit is contained in:
Sam Tobin-Hochstadt 2011-12-08 19:20:11 -05:00
parent b5d393d939
commit c22611ca2b
2 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
collects/htdp/testing.scrbl
View File

@ -1,26 +1,28 @@
#lang scribble/doc #lang scribble/doc
@(require scribble/manual @(require scribble/manual
(for-label test-engine/racket-tests)) (for-label test-engine/racket-tests (only-in htdp/testing generate-report)))
@title{Testing} @title{Testing}
@; ----------------------------------------------------------------------------- @; -----------------------------------------------------------------------------
@defmodule[htdp/testing #:use-sources (test-engine/racket-tests)] @defmodule[htdp/testing #:use-sources (test-engine/racket-tests)]
The library re-exports the following identifiers from test-engine/racket-tests: The library re-exports the following identifiers from @racketmodname[test-engine/racket-tests]
@deftogether[(
@defproc[(build-test-engine) void?] @defproc[(build-test-engine) void?]
@defproc[(builder) void?] @defproc[(builder) void?]
@defproc[(display-results) void?] @defproc[(display-results) void?]
@defproc[(error-handler) void?] @defproc[(error-handler) void?]
@defproc[(exn:fail:wish) void?] @defproc[(exn:fail:wish) void?]
@defproc[(generate-report) void?]
@defproc[(get-test-engine) void?] @defproc[(get-test-engine) void?]
@defproc[(reset-tests) void?] @defproc[(reset-tests) void?]
@defproc[(run-tests) void?] @defproc[(run-tests) void?]
@defproc[(scheme-test-data) void?] @defproc[(scheme-test-data) void?]
@defproc[(signature-test-info%) void?] @defproc[(signature-test-info%) void?])]
@defproc[(generate-report) void?]{The same as @racket[test].}
@(require scribble/eval @(require scribble/eval

22
collects/htdp/tests/test-docs-complete.rkt
View File

@ -4,6 +4,15 @@
(define (private-module s) #true) (define (private-module s) #true)
(define (legacy-module s) #true) (define (legacy-module s) #true)
(define hidden?
(lambda (h)
;; These identifiers are useful in some tests. They are like
;; 'friend' in C++ classes. If this weren't a legacy module, I'd
;; revise the architecture. -- Matthias
(define *hidden
'(draw begin-draw-sequence end-draw-sequence get-@VP get-mouse-event start-and-export))
(memq h *hidden)))
(check-docs (quote htdp/world)) (check-docs (quote htdp/world))
(check-docs (quote htdp/testing)) (check-docs (quote htdp/testing))
(check-docs (quote htdp/show-queen)) (check-docs (quote htdp/show-queen))
@ -18,22 +27,15 @@
(check-docs (quote htdp/master-play)) (check-docs (quote htdp/master-play))
(check-docs (quote htdp/lkup-gui)) (check-docs (quote htdp/lkup-gui))
(check-docs (quote htdp/image)) (check-docs (quote htdp/image))
(check-docs (quote htdp/hangman)) (check-docs (quote htdp/hangman) #:skip hidden?)
(check-docs (quote htdp/hangman-play)) (check-docs (quote htdp/hangman-play))
(check-docs (quote htdp/gui)) (check-docs (quote htdp/gui))
(check-docs (quote htdp/guess)) (check-docs (quote htdp/guess))
(check-docs (quote htdp/guess-gui)) (check-docs (quote htdp/guess-gui))
(check-docs (quote htdp/graphing)) (check-docs (quote htdp/graphing) #:skip hidden?)
(check-docs (quote htdp/error)) (check-docs (quote htdp/error))
(check-docs (quote htdp/elevator)) (check-docs (quote htdp/elevator))
(check-docs (quote htdp/draw) (check-docs (quote htdp/draw) #:skip hidden?)
#:skip (lambda (h)
;; These identifiers are useful in some tests. They are like
;; 'friend' in C++ classes. If this weren't a legacy module, I'd
;; revise the architecture. -- Matthias
(define *hidden
'(draw begin-draw-sequence end-draw-sequence get-@VP get-mouse-event start-and-export))
(memq h *hidden)))
(check-docs (quote htdp/draw-sig) #:skip private-module) (check-docs (quote htdp/draw-sig) #:skip private-module)
(check-docs (quote htdp/docs)) (check-docs (quote htdp/docs))
(check-docs (quote htdp/dir)) (check-docs (quote htdp/dir))