Struct DocEntry 

pub struct DocEntry {

    pub name: String,
    pub aliases: Vec<String>,
    pub module: String,
    pub section: Option<String>,
    pub summary: String,
    pub params: Vec<Param>,
    pub returns: Option<String>,
    pub since: Option<String>,
    pub deprecated: bool,
    pub see_also: Vec<String>,
    pub examples: Vec<String>,
    pub body: String,
    pub syntax: Option<String>,
    pub special_form: bool,
}

A fully resolved documentation entry (the serialized contract shared with LSP/REPL).

Fields

name: String

aliases: Vec<String>

module: String

section: Option<String>

summary: String

params: Vec<Param>

returns: Option<String>

since: Option<String>

deprecated: bool

see_also: Vec<String>

examples: Vec<String>

Runnable example snippets (the contents of ```sema fenced blocks in the body).

body: String

The full markdown body (including examples), used verbatim for hover.

syntax: Option<String>

Syntax template for special forms (e.g. (let ((name value) ...) body ...)). When present, shown as a signature block in hover and used as the label in signature help. Overrides flat parameter rendering for forms with complex syntax.

special_form: bool

true for special forms (no params schema; syntax lives in the body).

Trait Implementations

impl Clone for DocEntry

fn clone(&self) -> DocEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocEntry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocEntry

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocEntry

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.