Verilog Documentation Generator
veridoc-config.h File Reference

Contains data structures and functions for parsing veridoc configs. More...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "verilog-parser/src/verilog_ast_common.h"

Go to the source code of this file.

Data Structures

struct  veridoc_config
 Contains all of the configuration options for a run of veridoc. More...
 

Functions

void veridoc_config_free (veridoc_config *tofree)
 Frees the memory allocated to the supplied config file. More...
 
veridoc_configveridoc_config_parse (char *config_file_path, char *exe_path)
 Parses and returns the config file at the supplied path. More...
 

Detailed Description

Contains data structures and functions for parsing veridoc configs.

Function Documentation

void veridoc_config_free ( veridoc_config tofree)

Frees the memory allocated to the supplied config file.

< Project / Documentation Set Title.

< Documentation Authors

< Version Number

veridoc_config* veridoc_config_parse ( char *  config_file_path,
char *  exe_path 
)

Parses and returns the config file at the supplied path.

Parameters
[in]config_file_path
[in]exe_path- the value of argv[0]
Returns
A pointer to the supplied config structure or NULL if the file cannot be opened or parsed.
Parameters
[in]config_file_path
[in]exe_path- the value of argv[0]
Returns
A pointer to the supplied config structure.