Enum rhai_autodocs::module::options::ItemsOrder

pub enum ItemsOrder {
    Alphabetical,
    ByIndex,
}

Select in which order each doc item will be displayed.

Variants

Alphabetical

Display functions by alphabetical order.

ByIndex

Display functions by index using a pre-processing comment with the # rhai-autodocs:index:<number> syntax. The # rhai-autodocs:index:<number> line will be removed in the final generated markdown.

Example

/// Function that will appear first in docs.
///
/// # rhai-autodocs:index:1
#[rhai_fn(global)]
pub fn my_function1() {}

/// Function that will appear second in docs.
///
/// # rhai-autodocs:index:2
#[rhai_fn(global)]
pub fn my_function2() {}

Adding, removing or re-ordering your functions from your api can be a chore because you have to update all indexes by hand. Thankfully, you will found a python script in the scripts folder of the rhai-autodocs repository that will update the indexes by hand just for you.

The script generates a .autodocs file from your original source file, make sure to check that it did not mess with your source code using a diff tool.

Trait Implementations

impl Default for ItemsOrder

fn default() -> ItemsOrder

Returns the “default value” for a type.