scribble-enhanced/collects/tests/scribble/docs/manual.scrbl
Matthew Flatt 8876f00787 scribble/manual: add #:link-target?' to defproc', `defform', etc.
Specifying `#:link-target? #f' gets blue-box typesetting without
declaring documentaton for a binding.

original commit: 5c4a7db828b1e1d7d43047b6ba32b8a00297df44
2013-04-21 09:49:14 -06:00

68 lines
2.4 KiB
Racket

#lang scribble/manual
@(require (for-label racket/base
"manual-ex.rkt"))
@defmodule["manual-ex.rkt"]
@defproc[(f) integer?]{A function.}
@defproc[(g [x void?] [y void?]) integer?]{A function with two arguments.}
@defproc[#:kind "function" (h [x void?] [#:y y void?]) integer?]{A ``function'' with a keyword argument.}
@defproc[(i [x void?] [#:y y void? (void)]) integer?]{A function with an optional keyword argument.}
@defproc[#:link-target? #f (f) integer?]{A function, again, not a link target.}
@defproc[#:kind "function" #:link-target? #f (g [x void?]) integer?]{A ``function,'' again, not a link target.}
@defproc[#:id [i #'j] (i) void?]{Source is @racket[i], documents @racket[j].}
@defproc*[#:link-target? #f ([(f) integer?] [(g [x void?] [y void?]) void?])]{Functions, yet again.}
@defform[(m datum)]{A syntactic form.}
@defform[#:link-target? #f (m datum)]{A syntactic form, again.}
@defform[#:kind "macro" #:link-target? #f (m datum)]{A ``macro,'' again.}
@defform*[#:kind "macro" #:link-target? #f [(m datum) (m same-datum)]]{A ``macro,'' yet again.}
@defform/none[(m datum)]{Yet again.}
@defidform[n]{An identifier form.}
@defidform[#:link-target? #f n]{An identifier form, again.}
@specform[(m datum)]{Specification of @racket[m].}
@defparam[p k integer?]{A parameter}
@defparam[#:link-target? #f p k integer?]{A parameter, again.}
@defparam*[#:link-target? #f p k real? integer?]{A parameter, yet again.}
@defboolparam[q on?]{A boolean parameter.}
@defboolparam[#:link-target? #f q still-on?]{A boolean parameter, again.}
@defstruct[pt ([x real?] [y real?])]{A structure type with extra name.}
@defstruct*[pn ([x real?] [y real?])]{A structure type.}
@defstruct*[#:link-target? #f pn ([x real?] [y real?])]{A structure type, again.}
@defstruct*[#:link-target? #f pn ([x real?] [y real?]) #:transparent]{A transparent structure type, again.}
@defstruct*[#:link-target? #f pn ([x real?] [y real?]) #:inspector #f]{A transparent structure type, again.}
@defstruct*[#:link-target? #f pn ([x real?] [y real?]) #:prefab]{A prefab structure type, again.}
@defstruct*[#:link-target? #f pn ([x real?] [y real?]) #:constructor-name pt]{A structure type with name, again.}
@defstruct*[#:link-target? #f pn ([x real?] [y real?]) #:extra-constructor-name pt]{A structure type with extra name, again.}
@defstruct[#:link-target? #f pt ([x real?] [y real?]) #:mutable]{A mutable structure type with extra name, again.}