Verilog Documentation Generator
veridoc-page-factory.h
Go to the documentation of this file.
1 
7 #include <stdio.h>
8 #include <stdlib.h>
9 #include <string.h>
10 #include <assert.h>
11 
12 #include "veridoc-json.h"
13 #include "veridoc-types.h"
14 #include "veridoc-config.h"
15 #include "veridoc-manifest.h"
16 
17 #ifndef VERIDOC_PAGE_FACTORY_H
18 #define VERIDOC_PAGE_FACTORY_H
19 
26 void veridoc_pf_export_file_list_json(
27  veridoc_manifest * manifest,
28  json_file * fh
29 );
30 
31 
35 void veridoc_pf_export_module_list_json(
36  verilog_source_tree * source,
37  json_file * fh
38 );
39 
40 
46 json_object * veridoc_pf_export_hierarchy_json(
47  ast_module_declaration * top_module,
48  json_file * destination,
49  unsigned int depth
50 );
51 
52 
59 void veridoc_pf_build(
60  veridoc_manifest * manifest,
61  veridoc_config * config,
62  verilog_source_tree * source
63 );
64 
68 void veridoc_pf_copy_assets(
69  veridoc_config * config
70 );
71 
72 #endif
73 
veridoc-manifest.h
Contains common data structures and functions used on the file manifests.
veridoc_pf_export_module_list_json
void veridoc_pf_export_module_list_json(verilog_source_tree *source, json_file *fh)
Responsible for emitting the list of modules for the project.
Definition: veridoc-page-factory.c:130
veridoc_config
Contains all of the configuration options for a run of veridoc.
Definition: veridoc-config.h:18
veridoc_pf_export_file_list_json
void veridoc_pf_export_file_list_json(veridoc_manifest *manifest, json_file *fh)
Responsible for exporting the list of parsed files to a json data file.
Definition: veridoc-page-factory.c:99
veridoc_manifest
Contains a list of files to parse and document, and folders to search for header files in...
Definition: veridoc-manifest.h:42
veridoc-config.h
Contains data structures and functions for parsing veridoc configs.
veridoc_pf_export_hierarchy_json
json_object * veridoc_pf_export_hierarchy_json(ast_module_declaration *top_module, json_file *destination, unsigned int depth)
Responsible for emitting the verilog module hierarchy as JSON.
Definition: veridoc-page-factory.c:169
veridoc_pf_copy_assets
void veridoc_pf_copy_assets(veridoc_config *config)
Responsible for copying all template asset files to the output folder.
Definition: veridoc-page-factory.c:21
veridoc_pf_build
void veridoc_pf_build(veridoc_manifest *manifest, veridoc_config *config, verilog_source_tree *source)
Top level function for exporting the whole parsed data set to html.
Definition: veridoc-page-factory.c:376
json_file
A simple structure for helping to write out JSON encoded data.
Definition: veridoc-json.h:32
veridoc-types.h
Contains type definitions used globally by the program.
veridoc-json.h
Provides declarations of utility functions for writing JSON data to a file stream.