Struct DocIR 

pub struct DocIR {
    pub module_name: String,
    pub items: Vec<DocIRItem>,
}

Documentation IR — a flat list of documented declarations from one module.

Produced by emit_doc_ir and consumed by oxilean-doc to generate documentation without re-parsing the source file.

Fields

module_name: String

The module name (typically the file path without extension).

items: Vec<DocIRItem>

Documented declarations in declaration order.

Implementations

impl DocIR

pub fn to_json(&self) -> String

Serialise the entire DocIR to a JSON object string.

pub fn from_json(s: &str) -> Option<DocIR>

Deserialise a DocIR from a JSON string previously produced by DocIR::to_json.

This is a minimal round-trip parser covering only the exact output format emitted by to_json. It is not a general JSON parser.

Returns None if the input cannot be parsed.

Trait Implementations

impl Clone for DocIR

fn clone(&self) -> DocIR

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocIR

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

Formats the value using the given formatter.

impl PartialEq for DocIR

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocIR