./Source/generator.c

Generator/Generate_Header [ Functions ]

FUNCTION

Generate the documentation for all the items found in a header except for any items specified in configuration.ignore_items.

SYNOPSIS

static void Generate_Header(
    FILE *f,
    struct RB_header *header,
    char *docname )

INPUTS

f -- destination file
header -- header to be searched.
srcname -- name of the source file the header was found in.
docname -- name of the documentation file.

BUGS

This skips the first item body if the first item name was not correctly spelled.

SOURCE

{
    struct RB_Item     *cur_item;

    for ( cur_item = header->items; cur_item; cur_item = cur_item->next )
    {
        enum ItemType       item_type = cur_item->type;
        char               *name = configuration.items.names[item_type];

        if ( Is_Ignore_Item( name ) )
        {
            /* User does not want this item */
        }
        else if ( Works_Like_SourceItem( item_type )
                  && ( course_of_action.do_nosource ) )
        {
            /* User does not want source items */
        }
        else
        {
            Generate_Item( f, header, cur_item, docname );
        }
    }
}