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

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

View File

@ -26,6 +26,17 @@
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
[populate? boolean?]
[#:blueboxes-dirs blueboxes-dirs (listof path?) (get-doc-search-dirs)])

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
the tag that the class or interface documentation would have had,
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?])
constructor-tag?]{
Constructs a tag like @racket[definition-tag], except that
it matches documentation for the constructor of the class.
@history[#:added "1.11"]
}
@defproc[(get-class/interface-and-method [method-tag method-tag?])
(values symbol? symbol?)]{
Returns the class name and method name (respectively) for the method documented
by the docs at @racket[method-tag].
@history[#:added "1.11"]
}
@defproc[(definition-tag? [v any/c]) boolean?]{
Recognizes definition tags. If @racket[(definition-tag? _v)] is
@racket[#t], then so is @racket[(tag? _v)].
@history[#:added "1.11"]
}
@defproc[(class/interface-tag? [v any/c]) boolean?]{
Recognizes class or interface tags. If @racket[(class/interface-tag? _v)] is
@racket[#t], then so is @racket[(tag? _v)].
@history[#:added "1.11"]
}
@defproc[(method-tag? [v any/c]) boolean?]{
Recognizes method tags. If @racket[(method-tag? _v)] is
@racket[#t], then so is @racket[(tag? _v)].
@history[#:added "1.11"]
}
@defproc[(constructor-tag? [v any/c]) boolean?]{
Recognizes class constructor tags. If @racket[(constructor-tag? _v)] is
@racket[#t], then so is @racket[(tag? _v)].
@history[#:added "1.11"]
}