4.2.12 Index-Entry Descriptions
| (require scribble/manual-struct) | package: scribble-lib |
The
scribble/manual-struct library provides types used to
describe index entries created by scribble/manual
functions. These structure types are provided separate from
scribble/manual so that
scribble/manual need not be loaded when deserializing
cross-reference information that was generated by a previously
rendered document.
struct
(struct module-path-index-desc () #:extra-constructor-name make-module-path-index-desc)
Indicates that the index entry corresponds to a module definition via
defmodule and company.
struct
(struct language-index-desc module-path-index-desc () #:extra-constructor-name make-language-index-desc)
struct
(struct reader-index-desc module-path-index-desc () #:extra-constructor-name make-reader-index-desc)
Indicates that the index entry corresponds to a module definition via
defmodule with the #:lang or #:reader option.
For example, a module definition via defmodulelang has a
language-index-desc index entry and a module definition via
defmodulereader has a reader-index-desc index entry.
struct
(struct exported-index-desc (name from-libs) #:extra-constructor-name make-exported-index-desc) name : symbol? from-libs : (listof module-path?)
Indicates that the index entry corresponds to the definition of an
exported binding. The name field and from-libs list
correspond to the documented name of the binding and the primary
modules that export the documented name (but this list is not
exhaustive, because new modules can re-export the binding).
struct
(struct form-index-desc exported-index-desc () #:extra-constructor-name make-form-index-desc)
Indicates that the index entry corresponds to the definition of a
syntactic form via defform and company.
struct
(struct procedure-index-desc exported-index-desc () #:extra-constructor-name make-procedure-index-desc)
Indicates that the index entry corresponds to the definition of a
procedure binding via defproc and company.
struct
(struct thing-index-desc exported-index-desc () #:extra-constructor-name make-thing-index-desc)
Indicates that the index entry corresponds to the definition of a
binding via defthing and company.
struct
(struct struct-index-desc exported-index-desc () #:extra-constructor-name make-struct-index-desc)
Indicates that the index entry corresponds to the definition of a
structure type via defstruct and company.
struct
(struct class-index-desc exported-index-desc () #:extra-constructor-name make-class-index-desc)
Indicates that the index entry corresponds to the definition of a
class via defclass and company.
struct
(struct interface-index-desc exported-index-desc () #:extra-constructor-name make-interface-index-desc)
Indicates that the index entry corresponds to the definition of an
interface via definterface and company.
struct
(struct mixin-index-desc exported-index-desc () #:extra-constructor-name make-mixin-index-desc)
Indicates that the index entry corresponds to the definition of a
mixin via defmixin and company.
struct
(struct method-index-desc exported-index-desc ( method-name class-tag) #:extra-constructor-name make-method-index-desc) method-name : symbol? class-tag : tag?
Indicates that the index entry corresponds to the definition of an
method via defmethod and company. The name field
from exported-index-desc names the class or interface that
contains the method. The method-name field names the method.
The class-tag field provides a pointer to the start of the
documentation for the method’s class or interface.
struct
(struct constructor-index-desc exported-index-desc (class-tag) #:extra-constructor-name make-constructor-index-desc) class-tag : tag?
Indicates that the index entry corresponds to a constructor
via defconstructor and company. The name field
from exported-index-desc names the class or interface that
contains the method.
The class-tag field provides a pointer to the start of the
documentation for the method’s class or interface.