Following is a list of term/acronyms that may be used regularly throughout this document.
Is an exception that originates from a given function. I.e. Each originating exception corresponds directly to a single throw statement in the functions code. So if a function has two throw statements in its body, then it will have two Originating Exceptions.
Is an exception that may propagate out a function. This includes originating exceptions and all exceptions that may have entered this function by it calling other functions. Sometimes Propagating Exception is used to distinguish the difference between an exception that originates from the function and an exception that comes from another function.
An exception that occurs regularly and for all intents and purposes should not really be added to the generated documentation as it is expected to propagate out to the main() function and be reported as a bug. This is for things like assertion failures, segmentation faults etc.
The application which is part of the EDoc++ project suite that performs post processing on EDoc++ data files (.edc files)
A library component of the EDoc++ project that provides functionality for processing EDoc++ data files and manipulating them.
A python script designed to be used for manipulating the reporting and data representation of the edoc application. These scripts must have a .eds file extension.
A warning or error event emitted by the edoc application.
GNU Binutils Binary File Descriptor library. Used for embedding data into binary objects.
Embedded binary data
Refers to one or more EDoc++ data files (.edc) that have been embedded into a binary library or executable file using libbfd.
Refers to the data file that the edoc application uses to store information about a translation unit. This is the data generated from the GCC Modification program. It can be in either a EDoc Text format or an EDoc Binary Format, where the default is a binary format.
Possible Call/Possible Function Call
Refers to a function call that "might" be made by a direct call to a function pointer or a virtual function of a class member. Basically when either of these are called, the runtime behaviour might be such that it will actually make a call to one of many different functions. These are called "Possible Function Calls" and are thus a result of expanding the call-graph of a function pointer or virtual function.
Functions Declared Name
This is a name that represents the function in a format similar tot hat in which the user specified it. Future versions may return the name exactly as the user specified it. This differs from the link name which in C++ is a mangled name used by the linker.