Verilog Documentation Generator
veridoc-manifest.h File Reference

Contains common data structures and functions used on the file manifests. More...

#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include <dirent.h>
#include "veridoc-types.h"

Go to the source code of this file.

Data Structures

struct  veridoc_manifest
 Contains a list of files to parse and document, and folders to search for header files in. More...
 
struct  veridoc_manifest_directory
 A description of a directory to be included in the search path for header files. More...
 
struct  veridoc_manifest_file
 A description of a single file to be included in the parsed source tree. More...
 

Functions

void veridoc_manifest_free (veridoc_manifest *tofree)
 Frees a file manifest from memory.
 
veridoc_manifestveridoc_manifest_parse (char *path)
 Parses the supplied manifest file and returns a representation of it. More...
 

Detailed Description

Contains common data structures and functions used on the file manifests.

Function Documentation

veridoc_manifest* veridoc_manifest_parse ( char *  path)

Parses the supplied manifest file and returns a representation of it.

Parameters
[in]path- The manifest file to parse.
Returns
A pointer to the manifest object, or NULL if the file could not be found or parsed.