]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/regen.sh
wxSpinButton was missing in XRC spec, added
[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
9c981bfb 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
d513b59d
FM
59# Doxygen has the annoying habit to put the full path of the
60# affected files in the log file; remove it to make the log
61# more readable
62currpath=`pwd`/
2c58a7e7
FM
63interfacepath=`cd ../../interface && pwd`/
64cat doxygen.log | sed -e "s|$currpath||g" -e "s|$interfacepath||g" >temp
4514447c 65
edbbd747
FM
66# Doxygen warnings are not completely sorted for filename; enforce correct sorting:
67cat temp | sort >doxygen.log
68rm temp
4514447c 69
edbbd747 70# return to the original folder from which this script was launched
aa6ec1d7 71cd $current