`(sigil docs types)`

(sigil docs types) - Documentation Data Types

Defines the struct types used to represent module and export documentation throughout the docs system.

Exports

module-detailsprocedure

Construct a module-details struct.

module-details?procedure

Test if a value is a module-details struct.

module-details-nameprocedure

Get the name field of a module-details struct.

module-details-fileprocedure

Get the file field of a module-details struct.

module-details-packageprocedure

Get the package field of a module-details struct.

module-details-descriptionprocedure

Get the description field of a module-details struct.

module-details-exportsprocedure

Get the exports field of a module-details struct.

module-details-syntaxesprocedure

Get the syntaxes field of a module-details struct.

module-details-examplesprocedure

Get the examples field of a module-details struct.

export-detailsprocedure

Construct a export-details struct.

export-details?procedure

Test if a value is a export-details struct.

export-details-nameprocedure

Get the name field of a export-details struct.

export-details-kindprocedure

Get the kind field of a export-details struct.

export-details-signatureprocedure

Get the signature field of a export-details struct.

export-details-descriptionprocedure

Get the description field of a export-details struct.

export-details-examplesprocedure

Get the examples field of a export-details struct.

export-details-source-moduleprocedure

Get the source-module field of a export-details struct.

syntax-detailsprocedure

Construct a syntax-details struct.

syntax-details?procedure

Test if a value is a syntax-details struct.

syntax-details-nameprocedure

Get the name field of a syntax-details struct.

syntax-details-patternsprocedure

Get the patterns field of a syntax-details struct.

syntax-details-descriptionprocedure

Get the description field of a syntax-details struct.

syntax-details-examplesprocedure

Get the examples field of a syntax-details struct.