On this page:
module-path-index-desc
exported-index-desc
form-index-desc
procedure-index-desc
thing-index-desc
struct-index-desc
class-index-desc
interface-index-desc
mixin-index-desc
method-index-desc
Version: 4.2.1

11.12 Index-Entry Descriptions

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.

Indicates that the index entry corresponds to a module definition via defmodule and company.

(struct exported-index-desc (name from-libs))
  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).

Indicates that the index entry corresponds to the definition of a syntactic form via defform and company.

Indicates that the index entry corresponds to the definition of a procedure binding via defproc and company.

Indicates that the index entry corresponds to the definition of a binding via defthing and company.

Indicates that the index entry corresponds to the definition of a structure type via defstruct and company.

Indicates that the index entry corresponds to the definition of a class via defclass and company.

Indicates that the index entry corresponds to the definition of an interface via definterface and company.

Indicates that the index entry corresponds to the definition of a mixin via defmixin and company.

(struct (method-index-desc exported-index-desc) (method-name
    class-tag))
  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.