On this page:
fetch-blueboxes-strs
make-blueboxes-cache
blueboxes-cache?

6.10 Blue Boxes Utilities

 (require scribble/blueboxes) package: scribble-lib
The scribble/blueboxes provides access to the content of the “blue boxes” that describe some module’s export (but without any styling).

procedure

(fetch-blueboxes-strs tag 
  [#:blueboxes-cache blueboxes-cache]) 
  (or/c #f (non-empty-listof string?))
  tag : tag?
  blueboxes-cache : blueboxes-cache? = (make-blueboxes-cache)
Returns a list of strings that show the content of the blue box (without any styling information) for the documentation referenced by tag.

The first string in the list describes the export (e.g. "procedure" when defproc is used, or "syntax" when defform was used to document the export).

procedure

(make-blueboxes-cache populate?)  blueboxes-cache?

  populate? : boolean?
Constructs a new (mutable) blueboxes cache.

If populate? is #f, the cache is initially unpopulated, in which case it is filled in the first time the cache is passed to fetch-bluebxoes-strs. Otherwise, the cache is initially populated.

procedure

(blueboxes-cache? v)  boolean?

  v : any/c
Determines if v is a blueboxes cache.