Struct CommandDocumentation 

pub struct CommandDocumentation {
    pub path: String,
    pub name: String,
    pub parts: Vec<CommandPart>,
    pub is_query: bool,
    pub description: Option<String>,
    pub attributes: Option<Value>,
}

Represents a serializable SCPI command for documentation export.

Fields

path: String

The full canonical path of the command.

name: String

The name of the command as defined in the command definition.

parts: Vec<CommandPart>

The parts of the command.

is_query: bool

Whether the command is a query (ends with ?).

description: Option<String>

The plain text documentation.

attributes: Option<Value>

Structured data extracted from YAML blocks in the documentation.

Trait Implementations

impl Debug for CommandDocumentation

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

Formats the value using the given formatter.

impl Serialize for CommandDocumentation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.