]> de.git.xonotic.org Git - xonotic/netradiant.git/blobdiff - gendox
Merge commit '48410b113dd2036e69dbf723a39ec9af02fc9b12'
[xonotic/netradiant.git] / gendox
diff --git a/gendox b/gendox
index 935e052b6b00706ca196ce2b9d6ca7e051ba5a94..c25663fba370458c7692ce5b56bef80d88a0368e 100644 (file)
--- a/gendox
+++ b/gendox
-#!/bin/bash\r
-#\r
-# Shell script to make doxygen documentation by specifying a target directory\r
-# on the command line\r
-#\r
-# Gef (gefdavis@dingoblue.net.au) -- August 2001\r
-\r
-# TODO:\r
-# - Dynamic ChangeLog (page gets updated with each commit)\r
-# - Have the ability to specify server dox or local dox, which will then\r
-#   change the content on the main page\r
-# - Incorporate a scaled gtkradiant splash image into the pages\r
-\r
-#------------------------------------------------------------------------\r
-# Set some variables\r
-#------------------------------------------------------------------------\r
-# WORKINGDIR=`pwd`;\r
-RETVAL=0;\r
-TARGETSTRING='';\r
-EXTRAS_PATH="./Doxygen_files";\r
-CONFIG_OUTPUT="$EXTRAS_PATH/genConf";\r
-DOXYCONFIG="./DoxyConfig";\r
-DOXYFILE="$EXTRAS_PATH/Doxyfile";\r
-NEWDOXYFILE="$EXTRAS_PATH/genDoxyfile";\r
-declare -a TARGETLIST[$#];\r
-COUNTER=0;\r
-TARGETCOUNT=0;\r
-QUIETMODE=0;\r
-# added -k command line option to kill running doxygen procs\r
-KILLON=0\r
-\r
-#------------------------------------------------------------------------\r
-# load the functions\r
-#------------------------------------------------------------------------\r
-if [ -f "$EXTRAS_PATH/gendoxfunctions" ] ; then\r
-       . $EXTRAS_PATH/gendoxfunctions\r
-else\r
-  echo -e "Missing critical files...\n";\r
-  exit 1;\r
-fi\r
-\r
-#------------------------------------------------------------------------\r
-# parse the command line options\r
-#------------------------------------------------------------------------\r
-COMLINE="$*";\r
-OPTCOUNT="$#";\r
-parse_commandline;\r
-if [ $RETVAL -gt 0 ] ; then\r
-       echo -e "Exiting.";\r
-       exit $RETVAL;\r
-fi\r
-\r
-\r
-if [ $KILLON -gt 0 ] ; then\r
-  PIDOF_DOXYGEN=`pidof -x doxygen`\r
-  MYPID=$$\r
-  \r
-  if [ -z "$PIDOF_DOXYGEN" ] ; then\r
-    [ $QUIETMODE -gt 0 ] || echo -e " * Killing other doxygen pids";\r
-    killall -q -9 doxygen    \r
-  else\r
-    [ $QUIETMODE -gt 0 ] || echo -e " * Killing other doxygen pids";\r
-    kill -9 $PIDOF_DOXYGEN &> /dev/null\r
-  fi\r
-  \r
-  [ $QUIETMODE -gt 0 ] || echo -e " * Cleaning up gendox pids";\r
-  killall -q -9 `pidof -x gendox | sed -e s/$MYPID//` &> /dev/null\r
-  \r
-fi\r
-\r
-# If the output dir hasn't been set yet...\r
-#if [ -z "$OUTPUTDIR" ] ; then\r
-#      OUTPUTDIR="../$(basename `pwd`)-doxygen";\r
-#fi\r
-\r
-#------------------------------------------------------------------------\r
-# execute some functions to determine stuff(c)\r
-# Get the perl path (either from the config file, or find it)\r
-#------------------------------------------------------------------------\r
-get_perlpath;\r
-if [ X"$PERLPATH" == "X" ] ; then\r
-       echo -e "\nError: A working install of perl is needed to use doxygen";\r
-       exit 2;\r
-fi\r
-[ $QUIETMODE -gt 0 ] || echo -e " -> Set PERL_PATH to: $PERLPATH";\r
-\r
-get_dotpath;\r
-[ $QUIETMODE -gt 0 ] || echo -e " -> Set HAVE_DOT to: $HAVEDOT";\r
-if [ X"$HAVEDOT" == "XYes" ] ; then\r
-       [ $QUIETMODE -gt 0 ] || echo -e " -> Set DOT_PATH to: $DOTPATH";\r
-fi\r
-\r
-get_language;\r
-[ $QUIETMODE -gt 0 ] || echo -e " -> Set OUTPUT_LANGUAGE to: $OUPUTLANGUAGE";\r
-\r
-get_projectname;\r
-[ $QUIETMODE -gt 0 ] || echo -e " -> Set PROJECT_NAME to: $PROJECTNAME";\r
-\r
-get_version;\r
-[ $QUIETMODE -gt 0 ] || echo -e " -> Set PROJECT_NUMBER to: $VERSION";\r
-#------------------------------------------------------------------------\r
-# Got everything we need, now write the DoxyConfig file and run doxygen\r
-#------------------------------------------------------------------------\r
-\r
-# Clean up first\r
-clean_up;\r
-\r
-# Put the images & reference pages in the right place\r
-move_stuff;\r
-if [ $RETVAL -ge 666 ] ; then\r
-       exit 666;\r
-fi\r
-\r
-# Generate the config file\r
-gen_doxyconfig;\r
-if [ $RETVAL -gt 0 ] ; then\r
-       echo -e "Error: You are missing critical files."\r
-       exit RETVAL;\r
-fi\r
-\r
-# build the reference page and the index\r
-build_extra_html;\r
-\r
-# Generate documentation\r
-RETVAL=0;\r
-run_doxygen;\r
-if [ $RETVAL -gt 0 ] ; then\r
-       echo -e "Doxygen error: returned $RETVAL";\r
-       echo -e " Check doxygen.log for details";\r
-elif [ $RETVAL -lt 0 ] ; then\r
-       echo -e "Doxygen error: Doxygen returned $RETVAL";\r
-fi\r
-\r
-# if the log file is empty, remove it\r
-if [ ! -s ./doxygen.log ] ; then\r
-       rm -f ./doxygen.log\r
-fi\r
-\r
-#------------------------------------------------------------------------\r
-# Done.\r
-#------------------------------------------------------------------------\r
-[ $QUIETMODE -gt 0 ] || echo -e "Finished...";\r
-[ $QUIETMODE -gt 0 ] || echo -e "Duration: $SECONDS seconds\n";\r
-\r
-# echo -e "** Removing output while in debug mode **";\r
-# echo -e "** Output dir: $OUTPUTDIR **\n";\r
-# rm -rf $OUTPUTDIR\r
-\r
-exit 0;\r
-\r
+#!/bin/bash
+#
+# Shell script to make doxygen documentation by specifying a target directory
+# on the command line
+#
+# Gef (gefdavis@dingoblue.net.au) -- August 2001
+
+# TODO:
+# - Dynamic ChangeLog (page gets updated with each commit)
+# - Have the ability to specify server dox or local dox, which will then
+#   change the content on the main page
+# - Incorporate a scaled gtkradiant splash image into the pages
+
+#------------------------------------------------------------------------
+# Set some variables
+#------------------------------------------------------------------------
+# WORKINGDIR=`pwd`;
+RETVAL=0;
+TARGETSTRING='';
+EXTRAS_PATH="./Doxygen_files";
+CONFIG_OUTPUT="$EXTRAS_PATH/genConf";
+DOXYCONFIG="./DoxyConfig";
+DOXYFILE="$EXTRAS_PATH/Doxyfile";
+NEWDOXYFILE="$EXTRAS_PATH/genDoxyfile";
+declare -a TARGETLIST[$#];
+COUNTER=0;
+TARGETCOUNT=0;
+QUIETMODE=0;
+# added -k command line option to kill running doxygen procs
+KILLON=0
+
+#------------------------------------------------------------------------
+# load the functions
+#------------------------------------------------------------------------
+if [ -f "$EXTRAS_PATH/gendoxfunctions" ] ; then
+       . $EXTRAS_PATH/gendoxfunctions
+else
+  echo -e "Missing critical files...\n";
+  exit 1;
+fi
+
+#------------------------------------------------------------------------
+# parse the command line options
+#------------------------------------------------------------------------
+COMLINE="$*";
+OPTCOUNT="$#";
+parse_commandline;
+if [ $RETVAL -gt 0 ] ; then
+       echo -e "Exiting.";
+       exit $RETVAL;
+fi
+
+
+if [ $KILLON -gt 0 ] ; then
+  PIDOF_DOXYGEN=`pidof -x doxygen`
+  MYPID=$$
+  
+  if [ -z "$PIDOF_DOXYGEN" ] ; then
+    [ $QUIETMODE -gt 0 ] || echo -e " * Killing other doxygen pids";
+    killall -q -9 doxygen    
+  else
+    [ $QUIETMODE -gt 0 ] || echo -e " * Killing other doxygen pids";
+    kill -9 $PIDOF_DOXYGEN &> /dev/null
+  fi
+  
+  [ $QUIETMODE -gt 0 ] || echo -e " * Cleaning up gendox pids";
+  killall -q -9 `pidof -x gendox | sed -e s/$MYPID//` &> /dev/null
+  
+fi
+
+# If the output dir hasn't been set yet...
+#if [ -z "$OUTPUTDIR" ] ; then
+#      OUTPUTDIR="../$(basename `pwd`)-doxygen";
+#fi
+
+#------------------------------------------------------------------------
+# execute some functions to determine stuff(c)
+# Get the perl path (either from the config file, or find it)
+#------------------------------------------------------------------------
+get_perlpath;
+if [ X"$PERLPATH" == "X" ] ; then
+       echo -e "\nError: A working install of perl is needed to use doxygen";
+       exit 2;
+fi
+[ $QUIETMODE -gt 0 ] || echo -e " -> Set PERL_PATH to: $PERLPATH";
+
+get_dotpath;
+[ $QUIETMODE -gt 0 ] || echo -e " -> Set HAVE_DOT to: $HAVEDOT";
+if [ X"$HAVEDOT" == "XYes" ] ; then
+       [ $QUIETMODE -gt 0 ] || echo -e " -> Set DOT_PATH to: $DOTPATH";
+fi
+
+get_language;
+[ $QUIETMODE -gt 0 ] || echo -e " -> Set OUTPUT_LANGUAGE to: $OUPUTLANGUAGE";
+
+get_projectname;
+[ $QUIETMODE -gt 0 ] || echo -e " -> Set PROJECT_NAME to: $PROJECTNAME";
+
+get_version;
+[ $QUIETMODE -gt 0 ] || echo -e " -> Set PROJECT_NUMBER to: $VERSION";
+#------------------------------------------------------------------------
+# Got everything we need, now write the DoxyConfig file and run doxygen
+#------------------------------------------------------------------------
+
+# Clean up first
+clean_up;
+
+# Put the images & reference pages in the right place
+move_stuff;
+if [ $RETVAL -ge 666 ] ; then
+       exit 666;
+fi
+
+# Generate the config file
+gen_doxyconfig;
+if [ $RETVAL -gt 0 ] ; then
+       echo -e "Error: You are missing critical files."
+       exit RETVAL;
+fi
+
+# build the reference page and the index
+build_extra_html;
+
+# Generate documentation
+RETVAL=0;
+run_doxygen;
+if [ $RETVAL -gt 0 ] ; then
+       echo -e "Doxygen error: returned $RETVAL";
+       echo -e " Check doxygen.log for details";
+elif [ $RETVAL -lt 0 ] ; then
+       echo -e "Doxygen error: Doxygen returned $RETVAL";
+fi
+
+# if the log file is empty, remove it
+if [ ! -s ./doxygen.log ] ; then
+       rm -f ./doxygen.log
+fi
+
+#------------------------------------------------------------------------
+# Done.
+#------------------------------------------------------------------------
+[ $QUIETMODE -gt 0 ] || echo -e "Finished...";
+[ $QUIETMODE -gt 0 ] || echo -e "Duration: $SECONDS seconds\n";
+
+# echo -e "** Removing output while in debug mode **";
+# echo -e "** Output dir: $OUTPUTDIR **\n";
+# rm -rf $OUTPUTDIR
+
+exit 0;
+