./Source/generator.c

Generator/RB_Generate_TOC_2 [ Functions ]

FUNCTION

Create a Table of Contents based on the headers found in _all_ source files. There is also a function to create a table of contents based on the headers found in a single source file RB_Generate_TOC_1

SYNOPSIS

void RB_Generate_TOC_2(
    FILE *dest_doc,
    struct RB_header **headers,
    int count,
    struct RB_Part *owner,
    char *dest_name )

INPUTS

dest_doc -- the destination file.
headers -- an array of pointers to all the headers.
count -- the number of pointers in the array.
output_mode -- global with the current output mode.
owner -- The owner of the TOC. Only the headers that are owned by this owner are included in the TOC. Can be NULL, in which case all headers are included.

SOURCE

{
    switch ( output_mode )
    {
    case TEST:
        break;
    case TROFF:
        break;
    case XMLDOCBOOK:
        break;
    case HTML:
        RB_HTML_Generate_TOC_2( dest_doc, headers, count, owner, dest_name );
        break;
    case LATEX:
        /* LaTeX has it's own mechanism for creating
         * a table of content */
        break;
    case RTF:
        RB_RTF_Generate_TOC_2( dest_doc, headers, count );
        break;
    case ASCII:
        /* TODO: No TOC in ASCII mode */
        break;
    case UNKNOWN:

    default:
        assert( 0 );
    }
}