On this page:
defmodule/ this-package
defmodule*/ no-declare/ this-package
schememodname/ this-package
declare-exporting/ this-package
Version: 5.0.1

21 Scribble Documentation

 (require unstable/scribble)

This module provides tools for Scribble documentation; specifically, of PLaneT packages. In addition to the bindings described below, this module provides this-package-version-symbol from unstable/planet, this-package-in from unstable/require, and make-scribble-evaluator and make-scribble-module-evaluator from unstable/sandbox.

(defmodule/this-package)
(defmodule/this-package #:use-sources [src-path ...] [src ...])
(defmodule/this-package path)
(defmodule/this-package path #:use-sources [src-path ...] [src ...])
This Scribble form corresponds to defmodule within a planet package. The displayed module path is a planet module path to the current planet package, possibly with a ‹path› (from the grammar of planet module specs) into the package. If the #:use-sources option is present, each src-path is similarly treated as a path into the current planet package, while each src is treated normally. Both sets of paths are concatenated and passed to the normal defmodule.

(defmodule*/no-declare/this-package [src-path ...] [src ...])
This Scribble form corresponds to defmodule*/no-declare within a planet package. The displayed module paths are planet module paths to the current planet package, possibly with ‹path›s (from the grammar of planet module specs) into the package. Each src-path is similarly treated as a path into the current planet package, while each src is treated normally. Both sets of paths are concatenated and passed to the normal defmodule*/no-declare.

This Scribble form corresponds to schememodname much like defmodule/this-package above corresponds to defmodule. The path, if present, is treated as a ‹path› (from the grammar of planet module specs) into the current planet package, and converted into a planet module spec.

(declare-exporting/this-package [mod-path ...] [mod ...])
(declare-exporting/this-package [mod-path ...] [mod ...]
                                #:use-sources [src-path ...] [src ...])
This Scribble form corresponds to declare-exporting much like defmodule/this-package above corresponds to defmodule. Each mod-path and src-path is treated as a ‹path› (from the grammar of planet module specs) into the current package. They are concatenated with the lists of mods and srcs, respectively, and passed to the normal declare-exporting.