Struct AutoDocGenerator 

pub struct AutoDocGenerator { /* private fields */ }

Automatic documentation generator

Implementations

impl AutoDocGenerator

pub fn new(config: DocConfig) -> Self

Create a new documentation generator

pub fn parse_typescript( &mut self, typescript_content: &str, ) -> Result<(), JsValue>

Parse TypeScript definitions from string

pub fn generate_documentation(&self) -> Result<String, JsValue>

Generate documentation in the configured format

pub fn add_example(&mut self, example_json: &str) -> Result<(), JsValue>

Add a code example

pub fn generate_navigation(&self) -> String

Generate navigation structure

pub fn generate_api_reference(&self) -> String

Generate API reference

pub fn generate_playground(&self) -> String

Generate playground documentation

pub fn get_statistics(&self) -> String

Get statistics about the parsed TypeScript

Trait Implementations

impl From<AutoDocGenerator> for JsValue

fn from(value: AutoDocGenerator) -> Self

Converts to this type from the input type.

impl FromWasmAbi for AutoDocGenerator

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for AutoDocGenerator

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for AutoDocGenerator

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<AutoDocGenerator>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for AutoDocGenerator

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for AutoDocGenerator

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for AutoDocGenerator

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<AutoDocGenerator>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for AutoDocGenerator

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<AutoDocGenerator>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for AutoDocGenerator

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.

impl VectorFromWasmAbi for AutoDocGenerator

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[AutoDocGenerator]>

impl VectorIntoWasmAbi for AutoDocGenerator

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[AutoDocGenerator]>) -> Self::Abi

impl WasmDescribe for AutoDocGenerator

fn describe()

impl WasmDescribeVector for AutoDocGenerator

fn describe_vector()

impl SupportsConstructor for AutoDocGenerator

impl SupportsInstanceProperty for AutoDocGenerator

impl SupportsStaticProperty for AutoDocGenerator