|
|
|
|
|
00001 // This file has been modified on-the-fly with an input filter 00002 // to change it from Perl syntax to C++ strictly for the purposes 00003 // of faking out Doxygen. Modifications include: 00004 00005 // - changing local() definitions to C++ #define statements. 00006 // - commenting out undef statements. 00007 // - changing $globe'... variable names to $globe_... 00008 // - changing sub statements to look like C++ functions. 00009 // - changing # comments to C++ comments. 00010 // - ... 00011 00012 // If you see other strangeness in the HTML version of the Perl file, 00013 // it comes from getting it to look more C++ like. 00014 00015 00016 /*****************************************************************************/ 00017 /** @file 00018 ** @mainpage 00019 ** 00020 ** 00021 ** Technical Publications (TechPubs) Tools are Perl programs 00022 ** that are used to create a comprehensive HTML system from mini-HTML systems 00023 ** created by Doxygen and Mif2Go. 00024 ** 00025 ** These tools describes one possible solution to tackle two major tasks 00026 ** associated with application programming interface (API) technical 00027 ** publications:<ul> 00028 ** 00029 ** <li>Multiple output formats (HTML and PDF) that are single-sourced from 00030 ** (FrameMaker) documentation in a modular way.</li> 00031 ** 00032 ** <li>API reference documentation that is single-sourced from the (C/C++) 00033 ** source code into multiple output formats.</li></ul> 00034 ** 00035 ** Although the TechPubTools and techniques were designed specifically for 00036 ** C/C++ API documentation, they can be adopted and modified:<ul> 00037 ** 00038 ** <li>to produce large online documentation systems from multiple FrameMaker 00039 ** books.</li> 00040 ** <li>to produce large online documentation systems from multiple Doxygen 00041 ** directories.</li> 00042 ** <li>to handle (imperfectly) other programming languages.</li></ul> 00043 ** 00044 ** @warning The Perl Reference portion of this documentation has imperfections 00045 ** stemming from running Perl files through Doxygen, which was designed to 00046 ** handle C/C++. 00047 ** 00048 ** @lim Permission to use, copy, modify, and distribute this software and its 00049 ** documentation under the terms of the GNU General Public License is hereby 00050 ** granted. No representations are made about the suitability of this software 00051 ** for any purpose. It is provided "as is" without express or implied warranty. 00052 ** See the GNU General Public License 00053 ** (<a target="blank" href="http://www.gnu.org/copyleft/gpl.html">http://www.gnu.org/copyleft/gpl.html)</a> 00054 ** for more details. 00055 ** 00056 ** @note Documents produced by these tools are derivative works derived 00057 ** from the input used in their production; they are not affected by this 00058 ** license. 00059 ** 00060 ** 00061 ** <center><a target="top" href="http://www.voyanttech.com"> 00062 ** <img src="voyant.gif" ALT="Open new window to www.voyanttech.com." border="0"> 00063 ** </a></center> 00064 ** 00065 ** @ingroup tp_tools 00066 **/ 00067 /*****************************************************************************/ 00068 00069 00070 00071 00072 /*****************************************************************************/ 00073 // Standard Coding groups 00074 /*****************************************************************************/ 00075 /** @defgroup tp_tools TechPubs Tools 00076 ** @brief Tools for technical publications departments. 00077 **/ 00078 00079 /** @defgroup tp_idx Indexer Tools 00080 ** @brief Creates a comprehensive index from previously generated index_ files. 00081 ** @ingroup tp_tools 00082 **/ 00083 00084 /** @defgroup tp_nav Navigation Tools 00085 ** @brief Swaps out navigation, creates temporary TOC files and index_ files. 00086 ** @ingroup tp_tools 00087 **/ 00088 00089 /** @defgroup tp_dox Doxygen Filter Tools 00090 ** @brief Provides input filter to "fake-out" Doxygen into thinking it has 00091 ** C code. 00092 ** @ingroup tp_tools 00093 **/ 00094 00095 /** @defgroup tp_toc Table of Contents Tool 00096 ** @brief Generates master tree files from previously generated tree files 00097 ** to get master table of contents. 00098 ** @ingroup tp_tools 00099 **/ 00100 00101 /** @defgroup tp_latex Latex Tool 00102 ** @brief Provides minor updating to LaTex files. 00103 ** @ingroup tp_tools 00104 **/ 00105 00106 /** @defgroup tp_shell Unix Shell Scripts 00107 ** @brief Script files that control building and generating the system. 00108 ** @ingroup tp_tools 00109 **/ 00110 00111
|
|
|
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-perl-hcr-02