]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/regen.sh
fixing return values and handling of invalid files
[wxWidgets.git] / docs / doxygen / regen.sh
CommitLineData
85e43f4e 1#!/bin/bash
a7c93f3f 2#
cba817ac 3# $Id$
a7c93f3f 4#
cba817ac
FM
5# This bash script regenerates the HTML doxygen version of the
6# wxWidgets manual and adjusts the doxygen log to make it more
7# readable.
a7c93f3f
FM
8#
9# Usage:
189dea29 10# ./regen.sh [html|chm|xml|latex|all]
a7c93f3f 11#
189dea29 12# Pass "x" to regen only the X output format and "all" to regen them all.
a7c93f3f
FM
13# If no arguments are passed all formats are regenerated
14# (just like passing "all").
15#
16
cba817ac 17
189dea29 18# remember current folder and then cd to the docs/doxygen one
aa6ec1d7
FM
19me=$(basename $0)
20path=${0%%/$me} # path from which the script has been launched
21current=$(pwd)
22cd $path
e5156137 23export WXWIDGETS=`cd ../.. && pwd`
aa6ec1d7 24
a7c93f3f 25# prepare folders for the cp commands below
85e43f4e 26mkdir -p out/html # we need to copy files in this folder below
7a118965 27mkdir -p out/html/wxmsw out/html/wxgtk out/html/wxmac
4411a6b6 28
20a886a3
BP
29# These are not automatically copied by Doxygen because they're not
30# used in doxygen documentation, only in our html footer and by our
a7c93f3f 31# custom aliases
4411a6b6 32cp images/powered-by-wxwidgets.png out/html
cb2996e2 33cp images/logo_*.png out/html
7a118965
FM
34cp images/wxmsw/*png out/html/wxmsw
35cp images/wxmac/*png out/html/wxmac
36cp images/wxgtk/*png out/html/wxgtk
20a886a3 37cp wxwidgets.js out/html
d513b59d 38
a7c93f3f 39# this CSS is not automatically copied by Doxygen because it's
d513b59d
FM
40# included by our custom html header...
41cp wxwidgets.css out/html
42
a7c93f3f
FM
43# which configuration should we use?
44if [[ -z "$1" ]]; then
66e09890 45 cfgfile="Doxyfile_all"
a7c93f3f 46else
66e09890 47 cfgfile="Doxyfile_$1"
a7c93f3f
FM
48fi
49
85e43f4e
FM
50#
51# NOW RUN DOXYGEN
52#
53# NB: we do this _after_ copying the required files to the output folders
54# otherwise when generating the CHM file with Doxygen, those files are
55# not included!
56#
85e43f4e
FM
57doxygen $cfgfile
58
5590a552
FM
59if [[ "$1" = "qch" ]]; then
60 # we need to add missing files to the .qhp
61 cd out/html
62 qhelpfile="index.qhp"
63
74dda7b2
FM
64 # remove all <file> and <files> tags
65 cat $qhelpfile | grep -v "<file" >temp
5590a552 66
74dda7b2 67 # remove last 4 lines (so we have nothing after the last <keyword> tag)
5590a552 68 lines=$(wc -l < temp)
74dda7b2 69 wanted=`expr $lines - 4`
5590a552
FM
70 head -n $wanted temp >$qhelpfile
71
74dda7b2
FM
72 # generate a list of new <keyword> tags to add to the index file; without
73 # this step in the 'index' tab of Qt assistant the "wxWindow" class is not
74 # present; just "wxWindow::wxWindow" ctor is listed.
75 # NOTE: this operation is not indispensable but produces a QCH easier to use IMO.
76 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
77 cat temp >>$qhelpfile
78 echo " </keywords>" >>$qhelpfile
79 echo " <files>" >>$qhelpfile
80
81 # remove useless files to make the qch slim
82 rm temp *map *md5
5590a552
FM
83
84 # add a <file> tag for _any_ file in out/html folder except the .qhp itself
74dda7b2 85 for f in * */*png; do
5590a552
FM
86 if [[ $f != $qhelpfile ]]; then
87 echo " <file>$f</file>" >>$qhelpfile
88 fi
89 done
90
91 # add ending tags to the qhp file
92 echo " </files>
93 </filterSection>
94</QtHelpProject>" >>$qhelpfile
95
74dda7b2
FM
96 # replace keyword names so that they appear fully-qualified in the
97 # "index" tab of the Qt Assistant; e.g. Fit => wxWindow::Fit
98 # NOTE: this operation is not indispendable but produces a QCH easier to use IMO.
99 sed -e 's/<keyword name="[a-zA-Z:~]*" id="\([a-zA-Z]*::[a-zA-Z~]*\)"/<keyword name="\1" id="\1"/g' <$qhelpfile >temp
100 mv temp $qhelpfile
101
5590a552
FM
102 # last, run qhelpgenerator:
103 cd ../..
104 qhelpgenerator out/html/index.qhp -o out/wx.qch
105fi
106
d513b59d
FM
107# Doxygen has the annoying habit to put the full path of the
108# affected files in the log file; remove it to make the log
109# more readable
110currpath=`pwd`/
2c58a7e7
FM
111interfacepath=`cd ../../interface && pwd`/
112cat doxygen.log | sed -e "s|$currpath||g" -e "s|$interfacepath||g" >temp
4514447c 113
edbbd747
FM
114# Doxygen warnings are not completely sorted for filename; enforce correct sorting:
115cat temp | sort >doxygen.log
116rm temp
4514447c 117
edbbd747 118# return to the original folder from which this script was launched
aa6ec1d7 119cd $current