Verilog Documentation Generator
veridoc-config.h
Go to the documentation of this file.
1 
6 #include <stdio.h>
7 #include <stdlib.h>
8 #include <string.h>
9 
10 #include "verilog-parser/src/verilog_ast_common.h"
11 
12 #ifndef VERIDOC_CONFIG_H
13 #define VERIDOC_CONFIG_H
14 
18 typedef struct veridoc_config_t{
19 
20  char * v_project;
21  char * v_author;
22  char * v_version;
23  char * v_manifest;
24  char * v_output;
25  char * v_top_module;
26  char * v_assets_dir;
27  ast_list * v_includes;
29 
30 
39  char * config_file_path,
40  char * exe_path
41 );
42 
47  veridoc_config * tofree
48 );
49 
50 #endif
void veridoc_config_free(veridoc_config *tofree)
Frees the memory allocated to the supplied config file.
Definition: veridoc-config.c:156
char * v_author
Documentation Authors.
Definition: veridoc-config.h:21
char * v_output
Folder to put the results in.
Definition: veridoc-config.h:24
char * v_manifest
File manifest path.
Definition: veridoc-config.h:23
char * v_top_module
The root module of the hierarchy.
Definition: veridoc-config.h:25
Contains all of the configuration options for a run of veridoc.
Definition: veridoc-config.h:18
veridoc_config * veridoc_config_parse(char *config_file_path, char *exe_path)
Parses and returns the config file at the supplied path.
Definition: veridoc-config.c:14
char * v_version
Version Number.
Definition: veridoc-config.h:22
char * v_assets_dir
Where to look for template files.
Definition: veridoc-config.h:26
char * v_project
Project / Documentation Set Title.
Definition: veridoc-config.h:20
ast_list * v_includes
Include folders for header files.
Definition: veridoc-config.h:27