Struct FunctionDoc 

pub struct FunctionDoc {
    pub name: String,
    pub signature: String,
    pub description: String,
    pub parameters: Vec<Parameter>,
    pub returns: String,
    pub examples: Vec<String>,
    pub notes: Vec<String>,
}

Documentation for a single function

Fields

name: String

Function name

signature: String

Function signature

description: String

Function description

parameters: Vec<Parameter>

Function parameters

returns: String

Return type and description

examples: Vec<String>

Usage examples

notes: Vec<String>

Additional notes

Implementations

impl FunctionDoc

pub fn new( name: impl Into<String>, signature: impl Into<String>, description: impl Into<String>, returns: impl Into<String>, ) -> Self

Create a new function documentation entry

pub fn add_parameter(&mut self, parameter: Parameter)

Add a parameter to this function

pub fn add_example(&mut self, example: impl Into<String>)

Add an example to this function

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

Add a note to this function

Trait Implementations

impl Clone for FunctionDoc

fn clone(&self) -> FunctionDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDoc

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

Formats the value using the given formatter.

impl Serialize for FunctionDoc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.