|
|
|
|
|
The following are tools that were developed in Perl at Voyant Technologies, Inc. and are the heart of these TechPubTools. They are listed with a brief description and are covered in more detail in later chapters as well as the code reference portion of the HTML system.
voyant_nav.pl swaps out the head information, navigation controls, and copyright information. It also extracts temporary files used for the table of contents and index.
voyant_mt_app.pl uses the temporary files for the table of contents and generates a series of script files for the Java applet that are the master navigation over the whole system.
voyant_indexer.pl uses the temporary files for the index and generates a series of HTML files that are the master index over the whole system. It also performs word-chunking that expands the number of index entries and turns it into more of a concordance, a useful feature for programs.
voyant_latex.pl changes template LaTex files that were generated by Doxygen before LaTex is used to create PDF files.
dox_bug_filter.pl performs input filtering of source files into Doxygen to change elements, such as comment styles for more reliable output.
dox_ive_filter.pl performs input filtering of source files into Doxygen. The input files are known to be in the IVE language (Pascal-like). This imperfect filter makes those input files look more C-like in order for proper handling by Doxygen.
dox_comment_chg.pl performs input filtering of source files into Doxygen to change comment styles for more reliable output.
dox_chg_not.pl changes Doxygen comment styles. Intended to be used on source files that were initially documented using a style that the coding conventions later changed.
pl_comment_chg.pl performs very imperfect input filtering of source files into Doxygen. The input files are known to be in the Perl language. This imperfect filter makes those input files look more C-like in order for proper handling by Doxygen.
Although these tools are implemented and run in the UNIX environment, they could be used in the Windows environment and called from a batch file. (There are only a few areas where explicit UNIX system calls are made to generate lists and copy files. Equivalent system calls to DOS commands can accomplish the same task.)
|
|
|
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-hug-02