keywords_hash_s
[ Top ] [ Configuration ] [ Structures ]
FUNCTION
Structure for a keyword hash table row.
ATTRIBUTES
- keyword -- pointer to the keyword
- next -- pointer to next entry in the row
SOURCE
struct keywords_hash_s { struct keywords_hash_s *next; char *keyword; };
Parameters
[ Top ] [ Configuration ] [ Structures ]
FUNCTION
Structure to store all the paramters found in a block in the robodoc configuation file.
ATTRIBUTES
- number -- the number of parameters found.
- size -- the maximum size of the names array.
- names -- an array with the values of the parameters.
NOTES
Find a better name for the attribute 'names'
SOURCE
struct Parameters { unsigned int number; unsigned int size; char **names; };
RB_Configuration
[ Top ] [ Configuration ] [ Structures ]
FUNCTION
All the data from the robodoc.rc file is stored in this structure.
ATTRIBUTES
- items -- an array with names that robodoc recognizes as items. Alsways includes the name "SOURCE" as the first element.
- ignore_items -- an array with the names of items that ROBODoc should ignore.
- source_items -- an array with the names of items that work similar to the built-in SOURCE item.
- preformatted_items -- item names that will be automatically preformatted
- format_items -- item names that should be formatted by the browser
- item_order -- an array with item names that indicates which items should be displayed first.
- options -- Array with all options specified both on the commandline as well as in the robodoc.rc file.
- custom_headertypes -- list with custom header types.
- ignore_files -- list with wildcard expressions that specifies files and directories that robodoc should skip while scanning the source tree.
- header_markers -- list with markers that mark the begin of a header.
- remark_markers -- list with markers that mark a remark.
- end_markers -- list with markers that markt the end of a header.
- remark_begin_markers -- list of markers that mark the begin of a remark. For instance (*
- remakr_end_markers -- list of markers that mark the end of a remark. For instance *)
- keywords -- source keywords to recognise (and colorise)
- source_line_comments -- comment markers that span until the end of line
- header_ignore_chars -- characters for beginning of header remarks
- header_separate_chars -- characters that separates header artifacts
SOURCE
struct RB_Configuration { struct Parameters items; struct Parameters ignore_items; struct Parameters source_items; struct Parameters preformatted_items; struct Parameters format_items; struct Parameters item_order; struct Parameters options; struct Parameters ignore_files; struct Parameters accept_files; struct Parameters custom_headertypes; struct Parameters header_markers; struct Parameters remark_markers; struct Parameters end_markers; struct Parameters remark_begin_markers; struct Parameters remark_end_markers; struct Parameters keywords; struct Parameters source_line_comments; struct Parameters header_ignore_chars; struct Parameters header_separate_chars; };