Struct ApiDocumentation 

pub struct ApiDocumentation {
    pub name: String,
    pub signature: String,
    pub documentation: String,
    pub parameters: Vec<ApiParameter>,
    pub return_type: String,
    pub examples: Vec<String>,
}

API documentation for a function or method

Fields

name: String

Function/method name

signature: String

Function signature

documentation: String

Documentation comment

parameters: Vec<ApiParameter>

Parameters

return_type: String

Return type

examples: Vec<String>

Examples

Implementations

impl ApiDocumentation

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

Create new API documentation

pub fn with_documentation(self, doc: impl Into<String>) -> Self

Add documentation

pub fn with_parameter(self, param: ApiParameter) -> Self

Add a parameter

pub fn with_return_type(self, return_type: impl Into<String>) -> Self

Set return type

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

Add an example

Trait Implementations

impl Clone for ApiDocumentation

fn clone(&self) -> ApiDocumentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiDocumentation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiDocumentation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiDocumentation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.