removed wxAcceleratorTable copy ctor docs, no port implements it

[wxWidgets.git] / docs / doxygen / regen.sh

diff --git a/docs/doxygen/regen.sh b/docs/doxygen/regen.sh
index 2005887c9c0879b62bf13a16dae778310a7ebd53..00b0dbf3545ec33e9a2b48965071699f43ab49a5 100755 (executable)
--- a/docs/doxygen/regen.sh
+++ b/docs/doxygen/regen.sh
@@ -1,30 +1,69 @@
-#!/bin/sh
-
+#!/bin/bash
+#

 # $Id$
 # $Id$

-
+#

 # This bash script regenerates the HTML doxygen version of the
 # wxWidgets manual and adjusts the doxygen log to make it more
 # readable.
 # This bash script regenerates the HTML doxygen version of the
 # wxWidgets manual and adjusts the doxygen log to make it more
 # readable.

+#
+# Usage:
+#    ./regen.sh [html|chm|xml|latex|all]
+#
+# Pass "x" to regen only the X output format and "all" to regen them all.
+# If no arguments are passed all formats are regenerated
+# (just like passing "all").
+#
+

 
 

-doxygen
+# remember current folder and then cd to the docs/doxygen one
+me=$(basename $0)
+path=${0%%/$me}        # path from which the script has been launched
+current=$(pwd)
+cd $path

 
 

-# this image is not automatically copied by Doxygen because it's not
-# used in doxygen documentation but only in our html footer...
+# prepare folders for the cp commands below
+mkdir -p out/html       # we need to copy files in this folder below
+mkdir -p out/html/wxmsw out/html/wxgtk out/html/wxmac
+
+# these images are not automatically copied by Doxygen because they're not
+# used in doxygen documentation but only in our html footer and by our
+# custom aliases

 cp images/powered-by-wxwidgets.png out/html
 cp images/powered-by-wxwidgets.png out/html

+cp images/*logo.png out/html
+cp images/wxmsw/*png out/html/wxmsw
+cp images/wxmac/*png out/html/wxmac
+cp images/wxgtk/*png out/html/wxgtk

 
 

-# this CSS is automatically copied by Doxygen because it's 
+# this CSS is not automatically copied by Doxygen because it's

 # included by our custom html header...
 cp wxwidgets.css out/html
 
 # included by our custom html header...
 cp wxwidgets.css out/html
 

+# which configuration should we use?
+if [[ -z "$1" ]]; then
+    cfgfile="Doxyfile_all"
+else
+    cfgfile="Doxyfile_$1"
+fi
+
+#
+# NOW RUN DOXYGEN
+#
+# NB: we do this _after_ copying the required files to the output folders
+#     otherwise when generating the CHM file with Doxygen, those files are
+#     not included!
+#
+doxygen $cfgfile
+

 # Doxygen has the annoying habit to put the full path of the
 # affected files in the log file; remove it to make the log
 # more readable
 currpath=`pwd`/
 interfacepath=`cd ../../interface && pwd`/
 cat doxygen.log | sed -e "s|$currpath||g" -e "s|$interfacepath||g" >temp
 # Doxygen has the annoying habit to put the full path of the
 # affected files in the log file; remove it to make the log
 # more readable
 currpath=`pwd`/
 interfacepath=`cd ../../interface && pwd`/
 cat doxygen.log | sed -e "s|$currpath||g" -e "s|$interfacepath||g" >temp

-mv temp doxygen.log

 
 

-# filter out the following warning which we don't care about
-cat doxygen.log | grep -v ".*supplied.*as.*the.*argument.*is.*not.*an.*input.*file.*" >temp
-mv temp doxygen.log
+# Doxygen warnings are not completely sorted for filename; enforce correct sorting:
+cat temp | sort >doxygen.log
+rm temp

 
 

+# return to the original folder from which this script was launched
+cd $current