From 49802b7ba1842fb072ad061dfd39d240350bc88a Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Sun, 27 Nov 2011 11:14:58 -0700 Subject: [PATCH] doc correction Closes PR 12171 --- collects/scribblings/draw/bitmap-class.scrbl | 6 +++--- collects/scribblings/draw/bitmap-dc-class.scrbl | 10 ++++++---- collects/scribblings/draw/dc-intf.scrbl | 12 ++++++------ 3 files changed, 15 insertions(+), 13 deletions(-) diff --git a/collects/scribblings/draw/bitmap-class.scrbl b/collects/scribblings/draw/bitmap-class.scrbl index 0eb2e0fb3f..17f395ec29 100644 --- a/collects/scribblings/draw/bitmap-class.scrbl +++ b/collects/scribblings/draw/bitmap-class.scrbl @@ -23,7 +23,7 @@ A bitmap is convertible to @racket['png-bytes] through the 'xbm 'xbm/alpha 'xpm 'xpm/alpha 'bmp 'bmp/alpha) 'unknown] - [bg-color (or/c (is-a?/c color%) false/c) #f] + [bg-color (or/c (is-a?/c color%) #f) #f] [complain-on-failure? any/c #f]) ([bits bytes?] [width exact-positive-integer?] @@ -90,7 +90,7 @@ Gets the height of the bitmap in pixels. } @defmethod[(get-loaded-mask) - (or/c (is-a?/c bitmap%) false/c)]{ + (or/c (is-a?/c bitmap%) #f)]{ Returns a mask bitmap that is stored with this bitmap. @@ -155,7 +155,7 @@ Returns @racket[#f] if the bitmap is monochrome, @racket[#t] otherwise. 'xbm 'xbm/alpha 'xpm 'xpm/alpha 'bmp 'bmp/alpha) 'unknown] - [bg-color (or/c (is-a?/c color%) false/c) #f] + [bg-color (or/c (is-a?/c color%) #f) #f] [complain-on-failure? any/c #f]) boolean?]{ diff --git a/collects/scribblings/draw/bitmap-dc-class.scrbl b/collects/scribblings/draw/bitmap-dc-class.scrbl index 08dd5058ca..e7d4b95a71 100644 --- a/collects/scribblings/draw/bitmap-dc-class.scrbl +++ b/collects/scribblings/draw/bitmap-dc-class.scrbl @@ -17,7 +17,7 @@ Drawing to a @racket[bitmap-dc%] with a color bitmap is guaranteed to can be used for offscreen staging of canvas content. -@defconstructor[([bitmap (or/c (is-a?/c bitmap%) false/c)])]{ +@defconstructor[([bitmap (or/c (is-a?/c bitmap%) #f)])]{ Creates a new memory DC. If @racket[bitmap] is not @racket[#f], it is installed into the DC so that drawing commands on the DC draw to @@ -36,7 +36,9 @@ Creates a new memory DC. If @racket[bitmap] is not @racket[#f], it is [src-y real?] [src-width (and/c real? (not/c negative?))] [src-height (and/c real? (not/c negative?))] - [mask (or/c (is-a?/c bitmap%) false/c)]) + [style (one-of/c 'solid 'opaque 'xor) 'solid] + [color (is-a?/c color%) (send the-color-database find-color "black")] + [mask (or/c (is-a?/c bitmap%) #f) #f]) boolean?]{ The same as @method[dc<%> draw-bitmap-section], except that @@ -91,7 +93,7 @@ If @racket[pre-multiplied?] is true, @racket[just-alpha?] is false, } @defmethod[(get-bitmap) - (or/c (is-a?/c bitmap%) false/c)]{ + (or/c (is-a?/c bitmap%) #f)]{ Gets the bitmap currently installed in the DC, or @racket[#f] if no bitmap is installed. See @method[bitmap-dc% set-bitmap] for more @@ -153,7 +155,7 @@ If @racket[pre-multiplied?] is true, @racket[just-alpha?] is false, } -@defmethod[(set-bitmap [bitmap (or/c (is-a?/c bitmap%) false/c)]) +@defmethod[(set-bitmap [bitmap (or/c (is-a?/c bitmap%) #f)]) void?]{ Installs a bitmap into the DC, so that drawing operations on the bitmap diff --git a/collects/scribblings/draw/dc-intf.scrbl b/collects/scribblings/draw/dc-intf.scrbl index 131d1f6364..0807a9b6c5 100644 --- a/collects/scribblings/draw/dc-intf.scrbl +++ b/collects/scribblings/draw/dc-intf.scrbl @@ -85,7 +85,7 @@ If both the pen and brush are non-transparent, the wedge is filled [dest-y real?] [style (one-of/c 'solid 'opaque 'xor) 'solid] [color (is-a?/c color%) (send the-color-database find-color "black")] - [mask (or/c (is-a?/c bitmap%) false/c) #f]) + [mask (or/c (is-a?/c bitmap%) #f) #f]) boolean?]{ Displays the @racket[source] bitmap. The @racket[dest-x] and @racket[dest-y] arguments @@ -157,7 +157,7 @@ See also @method[dc<%> draw-bitmap-section]. [src-height (and/c real? (not/c negative?))] [style (one-of/c 'solid 'opaque 'xor) 'solid] [color (is-a?/c color%) (send the-color-database find-color "black")] - [mask (or/c (is-a?/c bitmap%) false/c) #f]) + [mask (or/c (is-a?/c bitmap%) #f) #f]) boolean?]{ Displays part of a bitmap. @@ -532,7 +532,7 @@ Unlike most methods, this method can be called for a } @defmethod[(get-clipping-region) - (or/c (is-a?/c region%) false/c)]{ + (or/c (is-a?/c region%) #f)]{ Gets the current clipping region, returning @racket[#f] if the drawing context is not clipped (i.e., the clipping region is the entire @@ -563,7 +563,7 @@ Gets the current font. See also @method[dc<%> set-font]. } @defmethod[(get-gl-context) - (or/c (is-a?/c gl-context<%>) false/c)]{ + (or/c (is-a?/c gl-context<%>) #f)]{ Returns a @racket[gl-context<%>] object for this drawing context if it supports OpenGL, @racket[#f] otherwise. @@ -673,7 +673,7 @@ set-text-background]. } @defmethod[(get-text-extent [string string?] - [font (or/c (is-a?/c font%) false/c) #f] + [font (or/c (is-a?/c font%) #f) #f] [combine? any/c #f] [offset exact-nonnegative-integer? 0]) (values (and/c real? (not/c negative?)) @@ -887,7 +887,7 @@ get-clipping-region]. } -@defmethod[(set-clipping-region [rgn (or/c (is-a?/c region%) false/c)]) +@defmethod[(set-clipping-region [rgn (or/c (is-a?/c region%) #f)]) void?]{ Sets the clipping region for the drawing area, turning off all