Contents 
 Index 
 "Shell Script Reference" 
 < Previous 
 Next > 

35_gen_tree.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_tree.b,v 1.2 2002/12/24 21:36:22 gmaxe Exp $
00014 ////
00015 /** @file
00016  ** @brief Calls tree_js_2_script.pl for the specified project.
00017  **
00018  ** @param dox_path A portion of the path used to distinguish the project.
00019  ** The final destination is assumed to be cref_<dox_path>. 
00020  ** 
00021  ** @param master_nav NOT USED. The name of an master HTML file that has 
00022  ** common HTML fragments which are to be inserted in all generated HTML pages. 
00023  **
00024  ** This is intended for doxygen projects that were previously generated.
00025  ** This functionality has since been built into 35_gen_dox.b, so this
00026  ** script doesn't have to be called as often.
00027  ** 
00028  ** It generates the mini-TOC script file which is later included in
00029  ** the master TOC file.
00030  ** 
00031  ** @lim This does not use the master_nav file, but by keeping the same
00032  ** input parameters as the 35_gen_dox.b, it is easier to call in scripts.
00033  ** 
00034  ** In addition, this only works on doxygen directories and assumes that 
00035  ** they begin with cref_<dox_path>
00036  **
00037  ** @ingroup tp_tools tp_shell
00038  **
00039  ** @author Glenn C. Maxey
00040  **/
00041 // //
00042 //// 2002 Created by Voyant Technologies, Inc., Westminster, Colorado, USA.
00043 ////
00044 //// Permission to use, copy, modify, and distribute this software and its 
00045 //// documentation under the terms of the GNU General Public License is hereby 
00046 //// granted. No representations are made about the suitability of this software 
00047 //// for any purpose. It is provided "as is" without express or implied warranty. 
00048 //// See the GNU General Public License (http://www.gnu.org/copyleft/gpl.html) 
00049 //// for more details.
00050 //// 
00051 //// Documents produced by this script are derivative works derived from the 
00052 //// input used in their production; they are not affected by this license.
00053 ////
00054 //// $Log: 35_gen_tree.b,v $
00055 //// Revision 1.2  2002/12/24 21:36:22  gmaxe
00056 //// Commented version.
00057 ////
00058 ////
00059 /////////////////////////////////////////////////////////////////////////////////
00060 // assumes that you are in the <rtfm/>techpubs/<home> directory 
00061 // where this script resides
00062 // This is a general script to simpify calling it from other places
00063 // echo "Entering 32_gen_tree..."
00064 // echo "Input argument $# $1 $2"
00065 
00066 set dox_path=$1
00067 set master_nav=$2
00068 
00069 echo "Calling tree_js_2_script.pl ..."
00070 /rtfm/techpubs/perl/tree_js_2_script.pl doc_publish/cref_${dox_path}/  doc_publish/cref_${dox_path}/tree.js
00071 set ret_val = $status
00072 if ($ret_val > 0) then
00073    echo "ERROR: Problems with tree_js_2_script.pl cref_${dox_path}."
00074    //  exit 1
00075 endif
00076 
00077 
00078 cp doc_publish/cref_${dox_path}/tree.script zdoc_merge/tree_cref_${dox_path}.script
00079 
00080 echo "Okay 35_gen_tree.b ${dox_path} ${master_nav}"
00081 exit 0
00082 


 "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