Enum gdnative_doc::backend::BuiltinBackend

pub enum BuiltinBackend {
    Markdown,
    Html,
    Gut,
}

Backend already implemented by this library.

This must be used in the Builder::add_backend method.

Variants

Markdown

Markdown backend

This generates a file for every structure that implements NativeClass + an index.md file that contains the crate's documentation.

Html

Html backend

This generates a file for every structure that implements NativeClass + an index.html file that contains the crate's documentation.

Also generates css and javascript files (for styling and code highlighting).

Gut

Gut backend

This generates a file for every structure that implements NativeClass, generating tests from gdscript code blocks:

#[derive(NativeClass)]
#[inherit(Node)]
pub struct MyClass {}

#[methods]
impl MyClass {
    /// ```gdscript
    /// var x = 0
    /// assert_eq(x, 0)
    /// ```
    pub fn new(_: &Node) -> Self {
        // ...
    }
}

Will generates the following in MyClass.gd:

extends "res://addons/gut/test.gd"

func test_new():
    var x = 0
    assert_eq(x, 0)

Trait Implementations

impl Clone for BuiltinBackend

fn clone(&self) -> BuiltinBackend

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BuiltinBackend

impl Debug for BuiltinBackend

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

Formats the value using the given formatter.

impl Eq for BuiltinBackend

impl Hash for BuiltinBackend

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for BuiltinBackend

fn cmp(&self, other: &BuiltinBackend) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<BuiltinBackend> for BuiltinBackend

fn eq(&self, other: &BuiltinBackend) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<BuiltinBackend> for BuiltinBackend

fn partial_cmp(&self, other: &BuiltinBackend) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for BuiltinBackend

impl StructuralPartialEq for BuiltinBackend