RB_Document
[ Top ] [ Document ] [ Structures ]
NAME
RB_Document -- Information store.
FUNCTION
A document is a collection of source files and documentation files. Depending on the mode that is used there is either a single documentation file or there is one documentation file for each source file. This mapping is stored in RB_Document. For each source file there is an RB_Part. It points to the source file, the documentation file, and contains all the headers that were found in the source file.
ATTRIBUTES
- links -- linked list of all links.
- parts -- linked list of all parts.
- no_headers -- total number of headers
- headers -- array of pointers to all the headers.
- srctree -- the list of all sourcefiles in the srcroot.
- doctype -- the kind of documentation to be generated.
- actions -- what to de while analysing en generating.
- srcroot -- root dir for the sourcecode.
- docroot -- root dir for the documentation.
- charset -- the character set used for HTML and XML documentation.
- first_section_level -- level of the first section, Defaults to 1 so the first section will be 1. If set to 2 the first section will be 1.1
- extension -- the extension used for the documentation files.
- css -- the cascading style sheet to be used.
- cur_part -- unused TODO remove.
SOURCE
struct RB_Document { struct RB_Part *cur_part; struct RB_Part *parts; struct RB_link *links; unsigned long no_headers; struct RB_header **headers; struct RB_Directory *srctree; T_RB_DocType doctype; /* HTML RTF etc */ actions_t actions; int first_section_level; /* TODO document use of first_section_level in manual */ long debugmode; /* TODO This should not be in document */ char *singledoc_name; struct RB_Path *srcroot; /* TODO Better make this a char* */ struct RB_Path *docroot; /* TODO Better make this a char* */ char *charset; /* HTML, XML? */ char *css; char *extension; char *compress; char *section; /* Docbook specific */ char *doctype_name; /* name part of the <!DOCTYPE> to be used with docbook output */ char *doctype_location;/* location part of the <!DOCTYPE> to be used with docbook output */ };