17.18 Documentation Metadata

8.15.0.12

17.18 Documentation Metadata🔗ℹ

The rhombus/doc module re-exports all of rhombus and adds DocSpec. The rhombus/doc module is intended in part as a submodule language for a splice that is generated by ~doc in forms such as fun or enum. The content of a DocSpec is intended for use by external tools such as Rhombus Scribble.

class

class DocSpec(headers :: List.of(Syntax),

content :: List.of(Syntax))

Each element of headers represents part of a declaration as useful to show in documentation, such as the arguments and result of a function, but not the function’s implementation. These syntax objects are meant to have no bindings, but they have source location and layout information to reconstruct the original text of the declaration.

The content list supplies a prose description the binding(s) in headers. The DocSpec form makes no requirement on the shape of each element in content, but the intent is that is suitable for use in a Rhombus Scribble document.

1	Notation and Conventions
2	Implicits and Context
3	Names and Definitions
4	Functions and Operators
5	Comparison and Branching
6	Objects and Annotations
7	Basic Data
8	Collections and Iteration
9	Object Protocols
10	Higher-Order Control
11	Code as Data
12	String Formatting and Matching
13	Input and Output
14	Operating System
15	Threads and Concurrency
16	Runtime System
17	Meta and Macros

17.1	Meta Definitions and Expressions
17.2	Spaces
17.3	Namespace Space
17.4	Definition Macros
17.5	Declaration Macros
17.6	Expression Macros
17.7	Assignment Macros
17.8	Binding Macros
17.9	Annotation Macros
17.10	Static Information
17.11	Dot Providers
17.12	Repetition Macros
17.13	Operator Orders
17.14	Form-Specific Macros
17.15	Syntax Objects in Macros
17.16	Syntax Parameters
17.17	Syntax Object Maps
17.18	Documentation Metadata