Skip to main content

Crate lsp_docs

Crate lsp_docs 

Source
Expand description

lsp-docs — static structured docs for the Axon language.

Build-time embedder (build.rs) walks content/{types,syntax,handlers}/*.md, parses each file’s frontmatter, and emits OUT_DIR/generated.rs. At runtime this crate exposes pre-allocated entries through find_doc and find_any_doc — no disk I/O, no allocation per lookup, and cargo tree -p lsp-docs --edges normal stays empty.

Consumed by lsp-core::hover (rich Markdown for built-in types and syntax keywords) and lsp-core::completion (decorating CompletionItem.documentation with the same Markdown).

Structs§

DocEntry
One documentation entry, generated at build time.

Enums§

DocKind
Topical bucket for a documentation entry.
Stability
Stability tier surfaced in the rendered hover header.

Functions§

entry_count
Number of entries shipped in this build. Useful for smoke tests (e.g., “we shipped at least N entries”).
find_any_doc
Look up the first entry with a given name, regardless of kind. Hover uses this when it doesn’t yet know whether the symbol is a type or a syntax keyword.
find_doc
Look up a documentation entry by (name, kind).
iter_entries
Iterate every entry. Order is stable: (kind, name) ascending.
render_doc
Render a Markdown header summarising entry’s frontmatter, followed by the body. Used by hover and completion.