Struct Documentation 

pub struct Documentation {
    pub summary: String,
    pub description: Option<String>,
    pub examples: Vec<Example>,
    pub notes: Vec<String>,
    pub see_also: Vec<String>,
}

Long-form documentation with examples and usage notes.

Fields

summary: String

Brief one-line summary

description: Option<String>

Detailed description (markdown supported)

examples: Vec<Example>

Usage examples

notes: Vec<String>

Usage notes and best practices

see_also: Vec<String>

Related symbols (predicates, domains)

Implementations

impl Documentation

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

Creates new documentation with a summary.

pub fn with_description(self, description: impl Into<String>) -> Self

Sets the detailed description.

pub fn add_example(&mut self, example: Example)

Adds an example.

pub fn add_note(&mut self, note: impl Into<String>)

Adds a usage note.

pub fn add_see_also(&mut self, symbol: impl Into<String>)

Adds a related symbol reference.

Trait Implementations

impl Clone for Documentation

fn clone(&self) -> Documentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Documentation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Documentation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Documentation

fn eq(&self, other: &Documentation) -> 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 Serialize for Documentation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Documentation