Verilog Documentation Generator
veridoc.h
1 
6 #include <stdio.h>
7 
8 #include "veridoc-types.h"
9 #include "veridoc-config.h"
10 #include "veridoc-manifest.h"
11 #include "veridoc-parsing.h"
12 #include "veridoc-page-factory.h"
13 
14 #ifndef VERIDOC_H
15 #define VERIDOC_H
16 
21 typedef struct shell_args_t{
22  boolean verbose;
23  char * config_path;
24  char * manifest_path;
25 } shell_args;
26 
31 shell_args * parse_args(int argc, char ** argv);
32 
33 
34 #endif
35 
veridoc-parsing.h
Contains data structures and functions for parsing verilog files.
shell_args::verbose
boolean verbose
Be verbose with status messages?
Definition: veridoc.h:22
veridoc-manifest.h
Contains common data structures and functions used on the file manifests.
veridoc-page-factory.h
Declares functions and structures responsible for building the documentation pages.
shell_args
Stores all of the command line arguments to the program.
Definition: veridoc.h:21
veridoc-config.h
Contains data structures and functions for parsing veridoc configs.
shell_args::config_path
char * config_path
Path to config file.
Definition: veridoc.h:23
parse_args
shell_args * parse_args(int argc, char **argv)
Responsible for parsing all of the command line arguments.
Definition: main.c:33
veridoc-types.h
Contains type definitions used globally by the program.
shell_args::manifest_path
char * manifest_path
Path to input file list.
Definition: veridoc.h:24