blueboxes.scrbl (2430B)
1 #lang scribble/doc 2 @(require scribble/manual "utils.rkt" 3 (for-label scribble/core 4 scribble/blueboxes 5 racket/contract 6 setup/xref)) 7 8 @title[#:tag "blueboxes"]{Blue Boxes Utilities} 9 10 @defmodule[scribble/blueboxes]{ 11 The @racketmodname[scribble/blueboxes] provides access 12 to the content of the ``blue boxes'' that describe 13 some module's export (but without any styling).} 14 15 @defproc[(fetch-blueboxes-strs [tag tag?] 16 [#:blueboxes-cache blueboxes-cache 17 blueboxes-cache? 18 (make-blueboxes-cache #t)]) 19 (or/c #f (non-empty-listof string?))]{ 20 Returns a list of strings that show the content of the blue box 21 (without any styling information) for the documentation referenced 22 by @racket[tag]. 23 24 The first string in the list describes the export (e.g. @racket["procedure"] 25 when @racket[defproc] is used, or @racket["syntax"] when @racket[defform] 26 was used to document the export). 27 } 28 29 @defproc[(fetch-blueboxes-method-tags [method-name symbol?] 30 [#:blueboxes-cache blueboxes-cache 31 blueboxes-cache? 32 (make-blueboxes-cache #t)]) 33 (listof method-tag?)]{ 34 Returns the list of tags for all methods that are documented in the documentation 35 in @racket[blueboxes-cache]. 36 37 @history[#:added "1.11"] 38 } 39 40 @defproc[(make-blueboxes-cache 41 [populate? boolean?] 42 [#:blueboxes-dirs blueboxes-dirs (listof path?) (get-doc-search-dirs)]) 43 blueboxes-cache?]{ 44 Constructs a new (mutable) blueboxes cache. 45 46 If @racket[populate?] is @racket[#f], the cache is initially 47 unpopulated, in which case it is filled in the first time the cache 48 is passed to @racket[fetch-bluebxoes-strs]. Otherwise, the cache is 49 populated immediately. 50 51 The @racket[blueboxes-dirs] argument is a list of directories that are 52 looked inside for @filepath{blueboxes.rktd} files. The default value 53 is only an approximation for where those files usually reside. See 54 also @racket[get-rendered-doc-directories]. 55 } 56 57 @defproc[(blueboxes-cache? [v any/c]) boolean?]{ 58 Determines if @racket[v] is a blueboxes cache. 59 }