docs

type Entry struct {
	// Name is the bare member name as it appears at runtime ("floor").
	// It must match the key the VM actually installs — the drift test
	// compares these against a live module table.
	Name string
	// Signature is the qualified call form ("math.floor(x): number").
	Signature string
	// Summary is a single sentence, shown in indexes and search results.
	Summary string
	// Detail is optional extra prose shown only on the full page.
	Detail string
	Kind   EntryKind
}

type EntryKind string

type Kind string

type Options struct {
	// Width is the target line width for wrapped prose.
	Width int
	// Color enables ANSI bold on headings and signatures.
	Color bool
}

type Result struct {
	Topic *Topic
	// Entry is nil when the topic itself matched.
	Entry *Entry
}

type Topic struct {
	// Name is the lookup key and the page title ("math", "std.stack").
	Name string
	Kind Kind
	// Aliases are alternative lookup keys ("globals" for "_G").
	Aliases []string
	// Title is the short "name — title" line under NAME.
	Title string
	// Synopsis is how you get hold of the namespace, verbatim luascript.
	Synopsis string
	// Detail is the DESCRIPTION body. Blank lines separate paragraphs;
	// lines starting with two spaces are kept verbatim (code samples).
	Detail  string
	Entries []Entry
	// Example is a runnable snippet, printed verbatim under EXAMPLES.
	Example string
	// SeeAlso lists related topic names.
	SeeAlso []string
	// RuntimeModule is the require() name whose live table backs this
	// topic, when there is one. Only set for KindModule and for objects
	// reachable from a module; the drift audit uses it.
	RuntimeModule string
	// RuntimeGlobal is the auto-global namespace backing this topic —
	// "string", "math", ... or "_G" for the globals table itself. A topic
	// may set both this and RuntimeModule (math and io do), in which case
	// the audit checks the union of the two surfaces.
	RuntimeGlobal string
	// Requireable marks an auto-global namespace that ALSO has a native
	// module of the same name with a larger surface (math and io). Such a
	// topic documents the union and is listed under both index headings;
	// entries that exist on only one of the two say so in their Detail.
	Requireable bool
}