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
This commit is contained in:
Francesco Montorsi
2008-11-28 19:28:15 +00:00
parent 5bc4758090
commit 5590a5529e
2 changed files with 57 additions and 0 deletions

24
docs/doxygen/Doxyfile_qch Normal file
View File

@@ -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

View File

@@ -56,6 +56,39 @@ 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 <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 # Doxygen has the annoying habit to put the full path of the
# affected files in the log file; remove it to make the log # affected files in the log file; remove it to make the log
# more readable # more readable