On this page:
defmodule*/  no-declare
defmodulelang*/  no-declare
defmodulereader*/  no-declare
4.2.2 Documenting Modules🔗


(defmodule maybe-req one-or-multi option ... pre-flow ...)

maybe-req = 
  | #:require-form content-or-proc-expr
one-or-multi = module-spec
  | #:multi (module-spec ...+)
module-spec = module-path
  | content-expr
option = #:module-paths (module-path ...)
  | #:no-declare
  | #:use-sources (src-module-path ...)
  | #:link-target? link-target?-expr
  | #:indirect
  | #:lang
  | #:reader
  | #:packages (pkg-expr ...)
Produces a sequence of flow elements (in a splice) to start the documentation for a module—or for multiple modules, if the #:multi form is used.

Each documented module specified as either a module-path (in the sense of require), in which case the module path is typeset using racketmodname, or by a content-expr. The latter case is triggered by the presence of a #:module-paths clause, which provides a plain module-path for each module-spec, and the plain module-path is used for cross-referencing.

If a #:require-form clause is provided and if #:lang and #:reader are not provided, the given expression produces either content to use instead of require for the declaration of the module, or a procedure that takes the typeset module name as an element and returns an element to use for the require form. The #:require-form clause is useful to suggest a different way of accessing the module instead of through require.

Besides generating text, unless #:no-declare appears as an option, this form expands to a use of declare-exporting with module-paths; the #:use-sources clause, if provided, is propagated to declare-exporting. Consequently, defmodule should be used at most once in a section without #:no-declare, though it can be shadowed with defmodules in sub-sections. Use #:no-declare form when you want to provide a more specific list of modules (e.g., to name both a specific module and one that combines several modules) via your own declare-exporting declaration

When #:link-target? is omitted or specified with an expression that produces a true value, then the module-paths are also declared as link targets though a part-tag-decl (which means that the defmodule form must appear before any sub-parts). These link targets are referenced via racketmodname, which thus points to the enclosing section, rather than the individual module-paths.

Specifying #:indirect normally makes sense only when #:link-target? is specified with a #f value. Specifying #:indirect makes the module path that is displayed (and that normally refers to some other declaration of the module) use racketmodname with #:indirect.

If #:lang is provided as an option, then the module name is shown after #lang (instead of in a require form) to indicate that the module-paths are suitable for use by either require or #lang. If the module path for require is syntactically different from the #lang form, use #:module-paths to provide the require variant (and make each module-spec a content-expr).

If #:reader is provided, then the module name is shown after #reader to indicate that the module path is intended for use as a reader module.

By default, the package (if any) that supplies the documented module is determined automatically, but a set of providing packages can be specified explicitly with #:packages. Each pkg-expr result is passed on to a function like tt for typesetting. Provide an empty sequence after #:packages to suppress any package name in the output. Each pkg-expr expression is duplicated for a declare-exporting form, unless #:no-declare is specified.

Each option form can appear at most once, and #:lang and #:reader are mutually exclusive.

The decoded pre-flows introduce the module, but need not include all of the module content.

Changed in version 1.43 of package scribble-lib: Supported a procedure value for #:require-form.


(declare-exporting module-path/escape ... maybe-pkgs maybe-sources)

maybe-pkgs = 
  | #:packages (pkg-expr ...)
maybe-sources = 
  | #:use-sources (module-path/escape ...)
module-path/escape = module-path
  | ,module-path-expr
Associates the module-paths to all bindings defined within the enclosing section, except as overridden by other declare-exporting declarations in nested sub-sections. The list of module-paths before #:use-sources is shown, for example, when the user hovers the mouse over one of the bindings defined within the section. A unquote-escaped ,module-path-expr can be used in place of a module-path to compute the module path dynamically.

More significantly, the first module-path before #:use-sources plus the module-paths after #:use-sources determine the binding that is documented by each defform, defproc, or similar form within the section that contains the declare-exporting declaration:

Use #:use-sources sparingly, but it is needed when

For example, the parameterize binding of mzscheme is documented as re-exported from racket/base, but parameterize happens to be implemented in a private module and re-exported by both racket/base and mzscheme. Importing parameterize from mzscheme does not go through racket/base, so a search for documentation on parameterize in mzscheme would not automatically connect to the documentation of racket/base. To make the connection, the documentation of racket/base declares the private module to be a source through #:use-sources, so that any re-export of parameterize from the private module connects to the documentation for racket/base (unless a re-export has its own documentation, which would override the automatic connection when searching for documentation).

The initial module-paths sequence can be empty if module-paths are given with #:use-sources. In that case, the rendered documentation never reports an exporting module for identifiers that are documented within the section, but the module-paths in #:use-sources provide a binding context for connecting (via hyperlinks) definitions and uses of identifiers.

Supply #:packages to specify the package that provides the declared modules, which is otherwise inferred automatically from the first module-path. The package names are used, for example, by history.

The declare-exporting form should be used no more than once per section, since the declaration applies to the entire section, although overriding declare-exporting forms can appear in sub-sections.

Changed in version 1.1 of package scribble-lib: Added #:packages clause.
Changed in version 1.17: Added support for ,module-path-expr.


(defmodulelang one-or-multi maybe-sources option ... pre-flow ...)

(defmodulelang one-or-multi #:module-path module-path
               option ... pre-flow ...)
Equivalent to defmodule with #:lang. The #:module-path module-path is provided, it is converted to #:module-paths (module-path).


(defmodulereader one-or-multi option ... pre-flow ...)

Equivalent to defmodule with #:reader.


(defmodule* maybe-req (module-spec ...+) option ... pre-flow ...)


(defmodulelang* (module-spec ...+) option ... pre-flow ...)


(defmodulereader* (module-spec ...+) option ... pre-flow ...)

Equivalent to defmodule variants with #:multi.


(defmodule*/no-declare maybe-req (module-spec ...) option ... pre-flow ...)


(defmodulelang*/no-declare (module-spec ...) option ... pre-flow ...)


(defmodulereader*/no-declare (module-spec ...) option ... pre-flow ...)

Equivalent to defmodule variants #:no-declare.