psDocumentAPI

Description

     This program generates web-pages that describe how to use an API.
This program reads an API Definition File and all C++ source code that
the API Definition File points to.   It organizes all this information
and the writes web pages describing all the API's classes and functions.

Syntax

psDocumentAPI -Iapi_definition_file -Bbase_dir_for_files_in_api_def_file
-Doutput_web_page_directory
-Abackground_color -aforeground_color
-Llink_color -lviewed_link_color -Kactive_link_color
-Cbackground_color_for_odd_rows -cbackground_color_for_even_rows
-Foutput_log_file -Ooptions

-I

Input API Definition File [/disk2/ceccareb/PS/package/parameters/PublicAPI.txt]

-B

Base directory for the API Definition File paths [/disk2/ceccareb/PS]

-D

Directory to write all the generated web pages [.]

-X

Checkmark GIF File relative to -D [./images/checkmark.gif]

-P

One Pixel GIF File relative to -D [./images/onepixel.gif]

-R

Architecture Jpeg File relative to -D [./images/PSArch.jpg]

-A

Background color for the page [FFFFFF]

-a

Foreground color for the page [000084]

-L

Link color [0000FF]

-l

Viewed link color [C000C0]

-K

Active link color [FF0000]

-C

Color background for odd numbered rows [FFFFFF]

-c

Color background for even-numbered_rows [F0F0F0]

-F

Output log file [standard output]

-O

Options

s

Do NOT sort functions alphabetically (as opposed to the order in the header files).

v

Verbose.  Write lots of progress messages to the log.

PS_SYSMSG_FILE

For the location of the system-wide messages file.

Notes

     The top most web page which psDocumentAPI generates is called API.html.
API.html will be in the -D directory.   From API.html, a web browser will be
able to traverse the entire web page structure.