From 5590a5529e8376bcb9eadf007335f760d8383a4e Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Fri, 28 Nov 2008 19:28:15 +0000 Subject: [PATCH] added the possibility (for doxygen >= 1.5.7.1) to generate a QCH file for wxWidgets documentation git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57009 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/doxygen/Doxyfile_qch | 24 ++++++++++++++++++++++++ docs/doxygen/regen.sh | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 docs/doxygen/Doxyfile_qch diff --git a/docs/doxygen/Doxyfile_qch b/docs/doxygen/Doxyfile_qch new file mode 100644 index 0000000000..3a1b5cdad5 --- /dev/null +++ b/docs/doxygen/Doxyfile_qch @@ -0,0 +1,24 @@ +############################################################################# +## Name: Doxyfile.qch +## Purpose: Doxygen configuration file for generating QCH only +## Author: Francesco Montorsi +## RCS-ID: $Id$ +## Licence: wxWindows license +############################################################################# + +@INCLUDE = Doxyfile_inc + +#--------------------------------------------------------------------------- +# Generation switches +#--------------------------------------------------------------------------- + +GENERATE_HTML = YES +GENERATE_QHP = YES + +# the qhelpgenerator utility is typically part of a package named like +# "qt4-dev-tools" in linux distributions: +##QHG_LOCATION = /usr/bin/qhelpgenerator + +# see http://doc.trolltech.com/4.4/qthelpproject.html for more info +QHP_NAMESPACE = wx +QHP_VIRTUAL_FOLDER = wxdoc diff --git a/docs/doxygen/regen.sh b/docs/doxygen/regen.sh index 259cd6f648..dc73729af0 100755 --- a/docs/doxygen/regen.sh +++ b/docs/doxygen/regen.sh @@ -56,6 +56,39 @@ fi # doxygen $cfgfile +if [[ "$1" = "qch" ]]; then + # we need to add missing files to the .qhp + cd out/html + qhelpfile="index.qhp" + + # remove lines + cat $qhelpfile | grep -v "\" >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 tag for _any_ file in out/html folder except the .qhp itself + for f in *; do + if [[ $f != $qhelpfile ]]; then + echo " $f" >>$qhelpfile + fi + done + + # add ending tags to the qhp file + echo " + +" >>$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 -- 2.45.2