Struct DocIRItem 

pub struct DocIRItem {
    pub name: String,
    pub kind: String,
    pub signature: String,
    pub doc_comment: String,
    pub deprecated: bool,
}

A single documented declaration extracted from an LcnfModule.

Fields

name: String

Fully-qualified declaration name.

kind: String

Declaration kind: "def", "axiom", or "extern".

"def" covers all top-level function declarations (including theorems and instances whose proofs have been compiled). "axiom" / "extern" is used for declarations that have no compiled body (external stubs, axioms, opaques).

signature: String

Pretty-printed type signature.

Currently always an empty string — type information is partially erased by the LCNF lowering pass and cannot be reliably reconstructed here.

doc_comment: String

Doc comment text.

Currently always empty; doc comments are not propagated into codegen. Use oxilean-doc’s source-level extractor for accurate doc comments.

deprecated: bool

Whether this declaration was annotated with @[deprecated].

Not preserved through the LCNF pipeline; always false here.

Implementations

impl DocIRItem

pub fn to_json(&self) -> String

Serialise this item to a JSON object string.

Trait Implementations

impl Clone for DocIRItem

fn clone(&self) -> DocIRItem

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocIRItem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DocIRItem

fn eq(&self, other: &DocIRItem) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DocIRItem