Skip to content
luxe API

luxe: docgen

DocGen

Section titled “DocGen”
import "luxe: docgen" for DocGen

no docs found

DocGen.config

Section titled “DocGen.config”
DocGen.config : Map

no docs found

DocGen.new(.)

Section titled “DocGen.new(.)”
DocGen.new(in_config : Map) : DocGen

no docs found

DocGen.get_param_string(.)

Section titled “DocGen.get_param_string(.)”
DocGen.get_param_string(parameters : Any) : unknown

no docs found

DocGen.get_param_string(..)

Section titled “DocGen.get_param_string(..)”
DocGen.get_param_string(parameters : Any, display : Any) : unknown

no docs found

DocGen.generate_from_module(.)

Section titled “DocGen.generate_from_module(.)”
DocGen.generate_from_module(module_path : String) : unknown

no docs found

DocGen.generate_from_module(..)

Section titled “DocGen.generate_from_module(..)”
DocGen.generate_from_module(config : Map, module_path : String) : unknown

takes a raw path for a module and tries to generate documentation for it

DocGen.get_ast_for_path(..)

Section titled “DocGen.get_ast_for_path(..)”
DocGen.get_ast_for_path(module_prefix : String, path : String) : unknown

no docs found

DocGen.generate(.)

Section titled “DocGen.generate(.)”
DocGen.generate() : unknown

no docs found

DocGen.generate_from_project(.)

Section titled “DocGen.generate_from_project(.)”
DocGen.generate_from_project(config : Any) : unknown

no docs found

DocGen.expr_to_string(.)

Section titled “DocGen.expr_to_string(.)”
DocGen.expr_to_string(expr : Expr) : unknown

no docs found

DocGen.generate_from_ast_nodes(..)

Section titled “DocGen.generate_from_ast_nodes(..)”
DocGen.generate_from_ast_nodes(config : Map, nodes : Map) : unknown

no docs found

DocGen.format_docs(.)

Section titled “DocGen.format_docs(.)”
DocGen.format_docs(meta_list : Any) : unknown

no docs found

DocGen.get_alias(..)

Section titled “DocGen.get_alias(..)”
DocGen.get_alias(meta : Any, name : Any) : unknown

no docs found

DocGen.arity(.)

Section titled “DocGen.arity(.)”
DocGen.arity(args : Any) : unknown

no docs found

DocGen.signature_url(…)

Section titled “DocGen.signature_url(…)”
DocGen.signature_url(name : Any, args : Any, setter : Any) : unknown

no docs found

DocGen.get_meta(.)

Section titled “DocGen.get_meta(.)”
DocGen.get_meta(source_meta : Any) : unknown

no docs found

DocGen.convert_meta(.)

Section titled “DocGen.convert_meta(.)”
DocGen.convert_meta(in_meta : Any) : unknown

no docs found