doc_generator.h File Reference

Documentation generation system for Luma language. More...

#include "../ast/ast.h"
#include "../c_libs/memory/memory.h"
#include <stdbool.h>
#include <stdio.h>

Include dependency graph for doc_generator.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	DocGenConfig
	Configuration for documentation generation. More...

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

Detailed Description

Documentation generation system for Luma language.

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

program	The root AST node (program)
config	Documentation 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

module	The module AST node
config	Documentation generation configuration
output_file	File to write documentation to

Returns

true if generation succeeded, false otherwise