cheng/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

splitted the Doxyfile in more files; now it's easy to generate only a single format or all of them without editing the cfg files

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52182 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi 2008-02-28 21:50:05 +00:00
parent de87600c5b
commit 85e43f4e9d
7 changed files with 134 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/doxygen/Doxyfile.all Normal file
View File

@ -0,0 +1,26 @@
#############################################################################
## Name: Doxyfile.all
## Purpose: Doxygen configuration file for generating all main formats
## Author: Francesco Montorsi
## RCS-ID: $Id: Doxyfile 52098 2008-02-26 00:05:33Z BP $
## Licence: wxWindows license
#############################################################################
@INCLUDE = Doxyfile.inc
#---------------------------------------------------------------------------
# Generation switches
#---------------------------------------------------------------------------
GENERATE_HTMLHELP = YES
GENERATE_HTML = YES
GENERATE_XML = YES
GENERATE_LATEX = NO
GENERATE_RTF = NO
GENERATE_MAN = NO
GENERATE_PERLMOD = NO
GENERATE_AUTOGEN_DEF = NO
GENERATE_TAGFILE = NO
HHC_LOCATION = ~/.wine/drive_c/Programmi/HTMLHelpWorkshop/hhc.exe

26
docs/doxygen/Doxyfile.chm Normal file
View File

@ -0,0 +1,26 @@
#############################################################################
## Name: Doxyfile.chm
## Purpose: Doxygen configuration file for generating CHM only
## Author: Francesco Montorsi
## RCS-ID: $Id: Doxyfile 52098 2008-02-26 00:05:33Z BP $
## Licence: wxWindows license
#############################################################################
@INCLUDE = Doxyfile.inc
#---------------------------------------------------------------------------
# Generation switches
#---------------------------------------------------------------------------
GENERATE_HTMLHELP = YES
GENERATE_HTML = NO
GENERATE_XML = NO
GENERATE_LATEX = NO
GENERATE_RTF = NO
GENERATE_MAN = NO
GENERATE_PERLMOD = NO
GENERATE_AUTOGEN_DEF = NO
GENERATE_TAGFILE = NO
HHC_LOCATION = ~/.wine/drive_c/Programmi/HTMLHelpWorkshop/hhc.exe

26
docs/doxygen/Doxyfile.html Normal file
View File

@ -0,0 +1,26 @@
#############################################################################
## Name: Doxyfile.html
## Purpose: Doxygen configuration file for generating HTML only
## Author: Francesco Montorsi
## RCS-ID: $Id: Doxyfile 52098 2008-02-26 00:05:33Z BP $
## Licence: wxWindows license
#############################################################################
@INCLUDE = Doxyfile.inc
#---------------------------------------------------------------------------
# Generation switches
#---------------------------------------------------------------------------
GENERATE_HTMLHELP = NO
GENERATE_HTML = YES
GENERATE_XML = NO
GENERATE_LATEX = NO
GENERATE_RTF = NO
GENERATE_MAN = NO
GENERATE_PERLMOD = NO
GENERATE_AUTOGEN_DEF = NO
GENERATE_TAGFILE = NO
HHC_LOCATION =

0
docs/doxygen/Doxyfile → docs/doxygen/Doxyfile.inc
View File

26
docs/doxygen/Doxyfile.xml Normal file
View File

@ -0,0 +1,26 @@
#############################################################################
## Name: Doxyfile.xml
## Purpose: Doxygen configuration file for generating XML only
## Author: Francesco Montorsi
## RCS-ID: $Id: Doxyfile 52098 2008-02-26 00:05:33Z BP $
## Licence: wxWindows license
#############################################################################
@INCLUDE = Doxyfile.inc
#---------------------------------------------------------------------------
# Generation switches
#---------------------------------------------------------------------------
GENERATE_HTMLHELP = NO
GENERATE_HTML = NO
GENERATE_XML = YES
GENERATE_LATEX = NO
GENERATE_RTF = NO
GENERATE_MAN = NO
GENERATE_PERLMOD = NO
GENERATE_AUTOGEN_DEF = NO
GENERATE_TAGFILE = NO
HHC_LOCATION =

12
docs/doxygen/regen.bat
View File

@ -4,7 +4,8 @@ REM This bash script regenerates the HTML doxygen version of the
REM wxWidgets manual and adjusts the doxygen log to make it more
REM readable.
doxygen
mkdir out
mkdir out\html
REM this image is not automatically copied by Doxygen because it's not
REM used in doxygen documentation but only in our html footer...
@ -13,3 +14,12 @@ copy images\powered-by-wxwidgets.png out\html
REM this CSS is automatically copied by Doxygen because it's
REM included by our custom html header...
copy wxwidgets.css out\html
REM
REM NOW RUN DOXYGEN
REM
REM NB: we do this _after_ copying the required files to the output folders
REM otherwise when generating the CHM file with Doxygen, those files are
REM not included!
REM
doxygen Doxyfile.all

23
docs/doxygen/regen.sh
View File

@ -1,4 +1,4 @@
#!/bin/sh
#!/bin/bash
# $Id$
@ -6,7 +6,7 @@
# wxWidgets manual and adjusts the doxygen log to make it more
# readable.
doxygen
mkdir -p out/html # we need to copy files in this folder below
# this image is not automatically copied by Doxygen because it's not
# used in doxygen documentation but only in our html footer...
@ -16,6 +16,21 @@ cp images/powered-by-wxwidgets.png out/html
# included by our custom html header...
cp wxwidgets.css out/html
#
# NOW RUN DOXYGEN
#
# NB: we do this _after_ copying the required files to the output folders
# otherwise when generating the CHM file with Doxygen, those files are
# not included!
#
if [[ -z "$1" ]]; then
cfgfile="Doxyfile.all"
else
cfgfile="Doxyfile.$1"
fi
doxygen $cfgfile
# 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
@ -25,6 +40,6 @@ 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
#cat doxygen.log | grep -v ".*supplied.*as.*the.*argument.*is.*not.*an.*input.*file.*" >temp
#mv temp doxygen.log