Enum rhai_autodocs::doc_item::DocItem

pub enum DocItem {
    Function {
        root_metadata: FunctionMetadata,
        metadata: Vec<FunctionMetadata>,
        name: String,
        index: usize,
    },
    CustomType {
        metadata: CustomTypesMetadata,
        index: usize,
    },
}

Generic representation of documentation for a specific item. (a function, a custom type, etc.)

Variants

Function

Fields

root_metadata: FunctionMetadata

metadata: Vec<FunctionMetadata>

name: String

index: usize

CustomType

Fields

metadata: CustomTypesMetadata

index: usize

Implementations

impl DocItem

pub fn new_function( metadata: &[FunctionMetadata], name: &str, namespace: &str, options: &Options ) -> Result<Option<Self>, AutodocsError>

pub fn new_custom_type( metadata: CustomTypesMetadata, namespace: &str, options: &Options ) -> Result<Option<Self>, AutodocsError>

pub fn index(&self) -> usize

pub fn name(&self) -> &str

pub fn find_index( name: &str, namespace: &str, doc_comments: &[String] ) -> Result<Option<usize>, AutodocsError>

Find the order index of the item by searching for the index pattern.

pub fn format_comments(doc_comments: &[String]) -> String

Format the function doc comments to make them into readable markdown.

pub fn remove_extra_tokens(dc: Vec<String>) -> Vec<String>

Remove crate specific comments, like rhai-autodocs:index.

pub fn fmt_doc_comments(dc: String) -> String

Remove doc comments identifiers.

pub fn remove_test_code(doc_comments: &str) -> String

NOTE: mdbook handles this automatically, but other markdown processors might not. Remove lines of code that starts with the ‘#’ token, which are removed on rust docs automatically.

Trait Implementations

impl Clone for DocItem

fn clone(&self) -> DocItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocItem

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

Formats the value using the given formatter.

impl Serialize for DocItem

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.