Contents 
 Index 
 "Shell Script Reference" 
 < Previous 
 Next > 

35_gen_dox.b

Go to the documentation of this file.
00001 // This file has been modified on-the-fly with an input filter
00002 // to change it from shell syntax to C++ strictly for the purposes
00003 // of faking out Doxygen. Modifications include:
00004 
00005 // - changing # comments to C++ comments.
00006 // - ...
00007 
00008 // If you see other strangeness in the HTML version of the script file,
00009 // it comes from getting it to look more C++ like.
00010 
00011 
00012 /////////////////////////////////////////////////////////////////////////////////
00013 //// $Id: 35_gen_dox.b,v 1.2 2002/12/24 21:36:21 gmaxe Exp $
00014 ////
00015 /** @file
00016  ** @brief Calls doxygen with the specified input directory and then copies
00017  ** generated files where they need to go for later processing.
00018  ** 
00019  ** @param dox_path A portion of the path used to distinguish the project.
00020  ** The final destination is assumed to be cref_<dox_path>. In addition,
00021  ** it is assumed that a related <dox_path>.dox configuration file for
00022  ** doxygen exists in the directory from where this was called.
00023  ** 
00024  ** @param master_nav The name of an master HTML file that has common HTML 
00025  ** fragments which are to be inserted in all generated HTML pages.
00026  ** 
00027  ** @param master_proj The name of the project_toc.txt file that defines
00028  ** all directories and their associated names, pdf files, and document numbers.
00029  ** 
00030  ** @lim This calls both 55_nav_gen.b and 56_nav_script.b with the information
00031  ** passed into this script. These were two steps that were often forgotten.
00032  ** Doxygen does not generate HTML based on the master navigation file, so
00033  ** 55_nav_gen.b forces the insertion of the standard tags. 
00034  ** 
00035  ** Likewise, this
00036  ** script by itself does not make sure that the master TOC script file is 
00037  ** updated. As such, after copying over the mini-index and mini-TOC files
00038  ** to a known location, this goes ahead regenerates the master TOC.
00039  ** 
00040  ** It does not regenerate the master index, because that is much more
00041  ** time-consuming.
00042  **
00043  ** @ingroup tp_tools tp_shell
00044  **
00045  ** @author Glenn C. Maxey
00046  **/
00047 // //
00048 //// 2002 Created by Voyant Technologies, Inc., Westminster, Colorado, USA.
00049 ////
00050 //// Permission to use, copy, modify, and distribute this software and its 
00051 //// documentation under the terms of the GNU General Public License is hereby 
00052 //// granted. No representations are made about the suitability of this software 
00053 //// for any purpose. It is provided "as is" without express or implied warranty. 
00054 //// See the GNU General Public License (http://www.gnu.org/copyleft/gpl.html) 
00055 //// for more details.
00056 //// 
00057 //// Documents produced by this script are derivative works derived from the 
00058 //// input used in their production; they are not affected by this license.
00059 ////
00060 //// $Log: 35_gen_dox.b,v $
00061 //// Revision 1.2  2002/12/24 21:36:21  gmaxe
00062 //// Commented version.
00063 ////
00064 ////
00065 /////////////////////////////////////////////////////////////////////////////////
00066 // assumes that you are in the <rtfm/>techpubs/<home> directory 
00067 // where this script resides
00068 // This is a general script to simpify calling it from other places
00069 // echo "Entering 32_gen_dox..."
00070 // echo "Input argument $# $1 $2"
00071 
00072 set dox_path=$1
00073 set master_nav=$2
00074 set master_proj=$3
00075 
00076 // Expect an error from this if the directory exists.
00077 mkdir doc_publish/cref_${dox_path}
00078 
00079 echo "Remove files from last run"
00080 rm doc_publish/cref_${dox_path}/*
00081 rm zlx_${dox_path}/*.*
00082 
00083 cp /rtfm/techpubs/web_files/*.css doc_publish/cref_${dox_path}/
00084 cp /rtfm/techpubs/web_files/*.gif doc_publish/cref_${dox_path}/
00085 
00086 echo "doxygen ${dox_path}.dox..."
00087 doxygen ${dox_path}.dox 
00088 set ret_val = $status
00089 if ($ret_val > 0) then
00090    echo "ERROR: Doxygen did not run on cref_${dox_path}."
00091    exit $ret_val
00092 endif
00093 
00094 echo "Calling tree_js_2_script.pl..."
00095 /rtfm/techpubs/perl/tree_js_2_script.pl doc_publish/cref_${dox_path}/  doc_publish/cref_${dox_path}/tree.js
00096 set ret_val = $status
00097 if ($ret_val > 0) then
00098    echo "ERROR: Did not create tree file on cref_${dox_path}."
00099    exit $ret_val
00100 endif
00101 
00102 echo "Calling voyant_nav.pl..."
00103 55_nav_gen.b doc_publish/ cref_${dox_path} ${master_nav} ${master_proj}
00104 set ret_val = $status
00105 if ($ret_val > 0) then
00106    echo "ERROR: Did not create tree file on cref_${dox_path}."
00107    exit $ret_val
00108 endif
00109 56_nav_script.b
00110 
00111 echo "Okay 35_gen_dox.b ${dox_path} ${master_nav} ${master_proj}"
00112 exit 0
00113 
00114 


 "Shell Script Reference" 
 < Previous 
 Next > 


Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003

TP Tools v2-00-0a

# tpt-script-hcr-02