► |  | Scribble: PLT Documentation Tool

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

▼ | 11 | Manual Forms

11.1 | Typesetting Code
11.2 | Documenting Modules
11.3 | Documenting Forms, Functions, Structure Types, and Values
11.4 | Documenting Classes and Interfaces
11.5 | Documenting Signatures
11.6 | Various String Forms
11.7 | Links
11.8 | Indexing
11.9 | Images
11.10 | Bibliography
11.11 | Miscellaneous
11.12 | Index-Entry Descriptions

On this page:

defsignature
defsignature/ splice
signature-desc
sigelem

Version: 4.1.4
top← prev up next →

#### 11.5`` Documenting Signatures

(defsignature id (super-id ...) pre-flow ...)

Defines a signature id that extends the super-id signatures. Any elements defined in decoded pre-flows – including forms, procedures, structure types, classes, interfaces, and mixins – are defined as members of the signature instead of direct bindings. These definitions can be referenced through sigelem instead of scheme.

The decoded pre-flows inset under the signature declaration in the typeset output, so no new sections, etc. can be started.

(defsignature/splice id (super-id ...) pre-flow ...)

Like defsignature, but the decoded pre-flows are not typeset under the signature declaration, and new sections, etc. can be started in the pre-flows.

(signature-desc pre-flow ...) → any/c
pre-flow : any/c

Produces an opaque value that defsignature recognizes to outdent in the typeset form. This is useful for text describing the signature as a whole to appear right after the signature declaration.

(sigelem sig-id id)

Typesets the identifier id with a hyperlink to its definition as a member of the signature named by sig-id.

top← prev up next →