Struct MatlabAnnotation 

pub struct MatlabAnnotation {
    pub summary: String,
    pub description: Option<String>,
    pub inputs: Vec<(String, String)>,
    pub outputs: Vec<(String, String)>,
    pub examples: Vec<String>,
    pub see_also: Vec<String>,
}

A MATLAB function documentation annotation.

Fields

summary: String

Short summary line.

description: Option<String>

Long description.

inputs: Vec<(String, String)>

Input parameter descriptions (name, description).

outputs: Vec<(String, String)>

Output descriptions (name, description).

examples: Vec<String>

Example lines.

see_also: Vec<String>

See-also references.

Implementations

impl MatlabAnnotation

pub fn new(summary: impl Into<String>) -> Self

Create a new annotation with just a summary.

pub fn input(self, name: impl Into<String>, desc: impl Into<String>) -> Self

Add an input description.

pub fn output(self, name: impl Into<String>, desc: impl Into<String>) -> Self

Add an output description.

pub fn example(self, code: impl Into<String>) -> Self

Add an example.

pub fn emit(&self) -> String

Emit as MATLAB % comment block.

Trait Implementations

impl Clone for MatlabAnnotation

fn clone(&self) -> MatlabAnnotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MatlabAnnotation

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

Formats the value using the given formatter.

impl PartialEq for MatlabAnnotation

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MatlabAnnotation