update date for 2.9.0 release; set the title to "Reference manual"

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

diff --git a/docs/doxygen/regen.sh b/docs/doxygen/regen.sh
index 75fce07801bcdab27b783ffeb3cdd7fdcaf428fc..a9dd32c9eb5263f2c8bce516a529d3895046e74d 100755 (executable)
--- a/docs/doxygen/regen.sh
+++ b/docs/doxygen/regen.sh
@@ -20,19 +20,21 @@ me=$(basename $0)
 path=${0%%/$me}        # path from which the script has been launched
 current=$(pwd)
 cd $path
 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
 
 
 # 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
+# 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
 # custom aliases
 cp images/powered-by-wxwidgets.png out/html

-cp images/*logo.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 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 not automatically copied by Doxygen because it's
 # included by our custom html header...
 
 # this CSS is not automatically copied by Doxygen because it's
 # included by our custom html header...


@@ -54,16 +56,64 @@ fi
 #
 doxygen $cfgfile
 
 #
 doxygen $cfgfile
 

+if [[ "$1" = "qch" ]]; then
+    # we need to add missing files to the .qhp
+    cd out/html
+    qhelpfile="index.qhp"
+
+    # remove all <file> and <files> tags
+    cat $qhelpfile | grep -v "<file" >temp
+
+    # remove last 4 lines (so we have nothing after the last <keyword> tag)
+    lines=$(wc -l < temp)
+    wanted=`expr $lines - 4`
+    head -n $wanted temp >$qhelpfile
+
+    # generate a list of new <keyword> tags to add to the index file; without
+    # this step in the 'index' tab of Qt assistant the "wxWindow" class is not
+    # present; just "wxWindow::wxWindow" ctor is listed.
+    # NOTE: this operation is not indispensable but produces a QCH easier to use IMO.
+    sed -e 's/<keyword name="wx[a-zA-Z~]*" id="wx\([a-zA-Z]*\)::[a-zA-Z~]*" ref="\([a-z_]*.html\)#.*"/<keyword name="wx\1" id="wx\1" ref="\2"/g' < $qhelpfile | grep "<keyword name=\"wx" | uniq >temp
+    cat temp >>$qhelpfile
+    echo "    </keywords>" >>$qhelpfile
+    echo "    <files>" >>$qhelpfile
+
+    # remove useless files to make the qch slim
+    rm temp *map *md5
+
+    # add a <file> tag for _any_ file in out/html folder except the .qhp itself
+    for f in * */*png; do
+        if [[ $f != $qhelpfile ]]; then
+            echo "      <file>$f</file>" >>$qhelpfile
+        fi
+    done
+
+    # add ending tags to the qhp file
+    echo "    </files>
+  </filterSection>
+</QtHelpProject>" >>$qhelpfile
+
+    # replace keyword names so that they appear fully-qualified in the
+    # "index" tab of the Qt Assistant; e.g. Fit => wxWindow::Fit
+    # NOTE: this operation is not indispendable but produces a QCH easier to use IMO.
+    sed -e 's/<keyword name="[a-zA-Z:~]*" id="\([a-zA-Z]*::[a-zA-Z~]*\)"/<keyword name="\1" id="\1"/g' <$qhelpfile >temp
+    mv temp $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
 # 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
 cd $current