Skip to main content

Module doc_ir

Module doc_ir 

Source
Expand description

Documentation Intermediate Representation (DocIR) for oxilean-codegen.

This module defines DocIR — a flat, serialisable representation of the documented declarations in a compiled LCNF module — and emit_doc_ir, which extracts it from an LcnfModule.

§Limitations

Doc comments are attached to declarations at the parse stage and are not propagated into the codegen IR. Consequently, DocIRItem::doc_comment will always be an empty string when produced by emit_doc_ir. For richly-documented output, callers should prefer source-level extraction (see oxilean-doc’s extractor module) and use DocIR only as a lightweight index of compiled declarations.

Structs§

DocIR
Documentation IR — a flat list of documented declarations from one module.
DocIRItem
A single documented declaration extracted from an LcnfModule.

Functions§

emit_doc_ir
Extract documentation IR from a compiled LcnfModule.