#!/bin/bash
-
+#
# $Id$
-
+#
# 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").
+#
+
+# 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
+export WXWIDGETS=`cd ../.. && pwd`
+# 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
-# this image is not automatically copied by Doxygen because it's not
-# used in doxygen documentation but only in our html footer...
+# These are not automatically copied by Doxygen because they're not
+# used in doxygen documentation, only in our html footer and by our
+# custom aliases
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
+cp wxwidgets.js out/html
-# 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
+# which configuration should we use?
+if [[ -z "$1" ]]; then
+ cfgfile="Doxyfile_all"
+else
+ cfgfile="Doxyfile_$1"
+fi
+
#
# NOW RUN DOXYGEN
#
# otherwise when generating the CHM file with Doxygen, those files are
# not included!
#
-if [[ -z "$1" ]]; then
- cfgfile="Doxyfile.all"
-else
- cfgfile="Doxyfile.$1"
-fi
-
doxygen $cfgfile
+if [[ "$1" = "qch" ]]; then
+ # we need to add missing files to the .qhp
+ cd out/html
+ qhelpfile="index.qhp"
+
+ # remove <file> lines
+ cat $qhelpfile | grep -v "\<file\>" >temp
+
+ # remove last 3 lines
+ lines=$(wc -l < temp)
+ wanted=`expr $lines - 3`
+ head -n $wanted temp >$qhelpfile
+
+ # remove useless .md5 and .map files
+ rm *map *md5
+
+ # add a <file> tag for _any_ file in out/html folder except the .qhp itself
+ for f in *; do
+ if [[ $f != $qhelpfile ]]; then
+ echo " <file>$f</file>" >>$qhelpfile
+ fi
+ done
+
+ # add ending tags to the qhp file
+ echo " </files>
+ </filterSection>
+</QtHelpProject>" >>$qhelpfile
+
+ # last, run qhelpgenerator:
+ cd ../..
+ qhelpgenerator out/html/index.qhp -o out/wx.qch
+fi
+
# 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