1 How to Scribble Documentation
2 Scribble Layers
3 @-Reader
4 Structures And Processing
5 Renderer
6 Decoding Text
7 Document Language
8 Document Reader
9 Basic Document Forms
10 Scheme
11 Manual Forms
12 Evaluation and Examples
13 BNF Grammars
14 Cross-Reference Utilities
15 Text Preprocessor
Index
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.0.2

 

11.12 Index-Entry Descriptions

 (require scribble/manual-struct)

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

 

module-path-index-desc

 

())

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).

(struct

 

(form-index-desc exported-index-desc)

 

())

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

(struct

 

(procedure-index-desc exported-index-desc)

 

())

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

(struct

 

(thing-index-desc exported-index-desc)

 

())

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

(struct

 

(struct-index-desc exported-index-desc)

 

())

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

(struct

 

(class-index-desc exported-index-desc)

 

())

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

(struct

 

(interface-index-desc exported-index-desc)

 

())

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

(struct

 

(mixin-index-desc exported-index-desc)

 

())

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.