suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

add some missing docs and @history annotations from commits e6630f0e9 and 39e0f6aec

Browse Source
This commit is contained in:
Robby Findler 2015-04-17 05:47:28 -05:00
parent b2255631a8
commit 3ea5bd2e31
2 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
scribble-doc/scribblings/scribble/blueboxes.scrbl
View File

@ -26,6 +26,17 @@
was used to document the export). was used to document the export).
} }
@defproc[(fetch-blueboxes-method-tags [method-name symbol?]
[#:blueboxes-cache blueboxes-cache
blueboxes-cache?
(make-blueboxes-cache #t)])
(listof method-tag?)]{
Returns the list of tags for all methods that are documented in the documentation
in @racket[blueboxes-cache].
@history[#:added "1.11"]
}
@defproc[(make-blueboxes-cache @defproc[(make-blueboxes-cache
[populate? boolean?] [populate? boolean?]
[#:blueboxes-dirs blueboxes-dirs (listof path?) (get-doc-search-dirs)]) [#:blueboxes-dirs blueboxes-dirs (listof path?) (get-doc-search-dirs)])

14
scribble-doc/scribblings/scribble/tag.scrbl
View File

@ -97,30 +97,44 @@ produce the same (i.e., @racket[eq?]) value.}
doesn't document a class or interface, this function still returns doesn't document a class or interface, this function still returns
the tag that the class or interface documentation would have had, the tag that the class or interface documentation would have had,
as if @racket[definition-tag] had documented a class or interface. as if @racket[definition-tag] had documented a class or interface.
@history[#:added "1.11"]
} }
@defproc[(class/interface-tag->constructor-tag [class/interface-tag class/interface-tag?]) @defproc[(class/interface-tag->constructor-tag [class/interface-tag class/interface-tag?])
constructor-tag?]{ constructor-tag?]{
Constructs a tag like @racket[definition-tag], except that Constructs a tag like @racket[definition-tag], except that
it matches documentation for the constructor of the class. it matches documentation for the constructor of the class.
@history[#:added "1.11"]
} }
@defproc[(get-class/interface-and-method [method-tag method-tag?]) @defproc[(get-class/interface-and-method [method-tag method-tag?])
(values symbol? symbol?)]{ (values symbol? symbol?)]{
Returns the class name and method name (respectively) for the method documented Returns the class name and method name (respectively) for the method documented
by the docs at @racket[method-tag]. by the docs at @racket[method-tag].
@history[#:added "1.11"]
} }
@defproc[(definition-tag? [v any/c]) boolean?]{ @defproc[(definition-tag? [v any/c]) boolean?]{
Recognizes definition tags. If @racket[(definition-tag? _v)] is Recognizes definition tags. If @racket[(definition-tag? _v)] is
@racket[#t], then so is @racket[(tag? _v)]. @racket[#t], then so is @racket[(tag? _v)].
@history[#:added "1.11"]
} }
@defproc[(class/interface-tag? [v any/c]) boolean?]{ @defproc[(class/interface-tag? [v any/c]) boolean?]{
Recognizes class or interface tags. If @racket[(class/interface-tag? _v)] is Recognizes class or interface tags. If @racket[(class/interface-tag? _v)] is
@racket[#t], then so is @racket[(tag? _v)]. @racket[#t], then so is @racket[(tag? _v)].
@history[#:added "1.11"]
} }
@defproc[(method-tag? [v any/c]) boolean?]{ @defproc[(method-tag? [v any/c]) boolean?]{
Recognizes method tags. If @racket[(method-tag? _v)] is Recognizes method tags. If @racket[(method-tag? _v)] is
@racket[#t], then so is @racket[(tag? _v)]. @racket[#t], then so is @racket[(tag? _v)].
@history[#:added "1.11"]
} }
@defproc[(constructor-tag? [v any/c]) boolean?]{ @defproc[(constructor-tag? [v any/c]) boolean?]{
Recognizes class constructor tags. If @racket[(constructor-tag? _v)] is Recognizes class constructor tags. If @racket[(constructor-tag? _v)] is
@racket[#t], then so is @racket[(tag? _v)]. @racket[#t], then so is @racket[(tag? _v)].
@history[#:added "1.11"]
} }