Luma 0.1.0
A low-level compiled alternative to C, C++, and more!
Loading...
Searching...
No Matches
Functions
doc_generator.c File Reference
#include "doc_generator.h"
#include <errno.h>
#include <string.h>
#include <sys/stat.h>
Include dependency graph for doc_generator.c:

Functions

bool generate_module_docs (AstNode *module, DocGenConfig config, FILE *f)
 Generate documentation for a single module.
 
bool generate_documentation (AstNode *program, DocGenConfig config)
 Generate documentation for an entire program.
 
DocGenConfig create_doc_config (ArenaAllocator *arena, const char *output_dir)
 Initialize documentation generator configuration.
 

Function Documentation

◆ create_doc_config()

DocGenConfig create_doc_config ( ArenaAllocator arena,
const char *  output_dir 
)

Initialize documentation generator configuration.

◆ generate_documentation()

bool generate_documentation ( AstNode program,
DocGenConfig  config 
)

Generate documentation for an entire program.

Parameters
programThe root AST node (program)
configDocumentation generation configuration
Returns
true if generation succeeded, false otherwise

◆ generate_module_docs()

bool generate_module_docs ( AstNode module,
DocGenConfig  config,
FILE *  output_file 
)

Generate documentation for a single module.

Parameters
moduleThe module AST node
configDocumentation generation configuration
output_fileFile to write documentation to
Returns
true if generation succeeded, false otherwise