syncdoc

Attribute Macro syncdoc 

Source
#[syncdoc]
Expand description

Injects documentation from an external file into a function.

§Examples

Document a single function:

#[syncdoc(path = "../docs/my_function.md")]
pub fn my_function(my_arg: usize) {
    println!("inside my_function!");
}

With a custom name:

#[syncdoc(path = "docs", name = "custom_name")]
pub fn my_function() {
    // Will look for ../docs/custom_name.md
}