Functions

fn doc_dispatch(parent_path: Path, uri_path: String, json_object: Object)

fn generate_docs(json_path: Path)

Structs

struct DocFunctionOverload

Aliases

alias __del__is_trivial

alias __moveinit__is_trivial

alias __copyinit__is_trivial

Fields

var name: String

var signature: String

var description: String

Functions

fn from_object(parent_path: Path, uri_path: String, json_object: Object) -> Self

fn to_markdown(self) -> String

struct DocFunction

Aliases

alias __del__is_trivial

alias __moveinit__is_trivial

alias __copyinit__is_trivial

Fields

var name: String

var signature: String

var overloads: List[DocFunctionOverload]

Functions

fn from_object(parent_path: Path, uri_path: String, json_object: Object) -> Self

fn to_markdown(self) -> String

struct DocField

Aliases

alias __del__is_trivial

alias __moveinit__is_trivial

alias __copyinit__is_trivial

Fields

var name: String

var type: String

var description: String

Functions

fn from_object(parent_path: Path, uri_path: String, json_object: Object) -> Self

fn to_markdown(self) -> String

struct DocAlias

Aliases

alias __del__is_trivial

alias __moveinit__is_trivial

alias __copyinit__is_trivial

Fields

var uri_path: String

var fs_path: Path

var name: String

var signature: String

var description: String

Functions

fn from_object(parent_path: Path, uri_path: String, json_object: Object) -> Self

fn to_markdown(self) -> String

struct DocStruct

Aliases

alias __del__is_trivial

alias __moveinit__is_trivial

alias __copyinit__is_trivial

Fields

var uri_path: String

var fs_path: Path

var name: String

var signature: String

var description: String

var aliases: List[DocAlias]

var fields: List[DocField]

var functions: List[DocFunction]

Functions

fn from_object(parent_path: Path, uri_path: String, json_object: Object) -> Self

fn to_markdown(self) -> String

struct DocModule

Aliases

alias __del__is_trivial

Fields

var uri_path: String

var fs_path: Path

var name: String

var description: String

var structs: List[DocStruct]

var aliases: List[DocAlias]

var functions: List[DocFunction]

Functions

fn to_file(parent_path: Path, uri_path: String, json_object: Object)

fn to_markdown(self, parent: String) -> String

fn write_to[W: Writer](self, mut writer: W)

struct DocPackage

Aliases

alias __del__is_trivial

Fields

var uri_path: String

var fs_path: Path

var name: String

Functions

fn to_file(parent_path: Path, uri_path: String, json_object: Object)

fn write_to[W: Writer](self, mut writer: W)