Headers/RB_header [ Structures ]
FUNCTION
This structure is used to store the headers that are extracted from the source files.
MODIFICATION HISTORY
- 8. August 1995: Koessi changed int version to char *version
- 5. December 2007: Budai changed the type of lines from char to struct RB_header_lines
ATTRIBUTES
- next -- used to store RB_headers in a RB_Part as a linked list.
- parent -- the parent of this header
- name -- the full name of the header modulename/functionname [versioninfo]
- owner -- the Part that owns this header.
- htype -- the type of this header.
- items -- pointers to the items in this header.
- version -- unused
- function_name -- the functionname ( a better name would be objectname or thingy name, it is the name of the thing that is being documented ).
- module_name -- the modulename
- unique_name -- unique name used for labels.
- file_name -- documentation file of this header.
- lines -- content of the header with line numbers
- no_lines -- number of lines in the content.
- line_number -- the line number at which the header was found in the source file.
SOURCE
struct RB_header { struct RB_header *next; struct RB_header *parent; struct RB_Part *owner; struct RB_HeaderType *htype; struct RB_Item *items; int is_internal; char *name; char **names; int no_names; char *version; char *function_name; char *module_name; char *unique_name; char *file_name; struct RB_header_lines *lines; int no_lines; int line_number; };