← Index

x/doc/doc-gen

Documentation generator from x-lang source tokens; output format rides an emitter (x/doc/emit).

%doc-sym-is?

Test if a value is a symbol matching a name string (cross-base safe).

Returns: BOOL — True if sym is a symbol with the given name

%doc-extract

Extract structured metadata from a (doc …) form.

Returns: LIST — (name desc params returns examples sees notes)

%doc-emit-entry

Emit a single entry’s documentation through an emitter.

%doc-build-lookup

Build a lookup alist from (doc …) forms in a token stream.

Returns: LIST — Alist of (name-string . extracted-7-tuple) pairs

%doc-lookup-alist

Cross-base-safe lookup in a doc alist by name string.

Returns: LIST — Extracted 7-tuple, or () if not found

%doc-walk-with-prims

Walk source tokens, using prims-alist as fallback docs for bare defs.

%doc-walk

Walk a token tree, emitting all documentation through an emitter.