X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/74dda7b23be94b266fbdeb3fcfd68c2b1d90aec7..973abcbb6acfbc5985191ff655c233a80c98754e:/docs/doxygen/regen.sh diff --git a/docs/doxygen/regen.sh b/docs/doxygen/regen.sh index cd101108e5..1a5d7f067e 100755 --- a/docs/doxygen/regen.sh +++ b/docs/doxygen/regen.sh @@ -20,32 +20,91 @@ me=$(basename $0) path=${0%%/$me} # path from which the script has been launched current=$(pwd) cd $path -export WXWIDGETS=`cd ../.. && pwd` +if [[ -z "$WXWIDGETS" ]]; then + # Notice the use of -P to ensure we get the canonical path even if there + # are symlinks in the current path. This is important because Doxygen + # strips this string from the paths in the generated files textually and it + # wouldn't work if it contained symlinks. + WXWIDGETS=`cd ../.. && pwd -P` + if [ "$OSTYPE" = "cygwin" ]; then + WXWIDGETS=`cygpath -w $WXWIDGETS` + fi + export WXWIDGETS +fi + +if [ "$DOXYGEN" = "" ]; then + DOXYGEN=doxygen +fi + +# Check that doxygen has the correct version as different versions of it are +# unfortunately not always (in fact, practically never) compatible. +# +# Still allow using incompatible version for some quick local testing if really +# needed and 1.8.2 can't be installed for whatever reason. +if [[ -z $WX_SKIP_DOXYGEN_VERSION_CHECK ]]; then + doxygen_version=`$DOXYGEN --version` + doxygen_version_required=1.8.2 + if [[ $doxygen_version != $doxygen_version_required ]]; then + echo "Doxygen version $doxygen_version is not supported." + echo "Please use Doxygen $doxygen_version_required or export WX_SKIP_DOXYGEN_VERSION_CHECK." + exit 1 + fi +fi # prepare folders for the cp commands below mkdir -p out/html # we need to copy files in this folder below -mkdir -p out/html/wxmsw out/html/wxgtk out/html/wxmac +mkdir -p out/html/generic # These are not automatically copied by Doxygen because they're not # used in doxygen documentation, only in our html footer and by our # custom aliases -cp images/powered-by-wxwidgets.png out/html -cp images/*logo.png out/html -cp images/wxmsw/*png out/html/wxmsw -cp images/wxmac/*png out/html/wxmac -cp images/wxgtk/*png out/html/wxgtk -cp wxwidgets.js out/html - -# this CSS is not automatically copied by Doxygen because it's -# included by our custom html header... -cp wxwidgets.css out/html - -# which configuration should we use? -if [[ -z "$1" ]]; then - cfgfile="Doxyfile_all" -else - cfgfile="Doxyfile_$1" -fi +cp images/generic/*png out/html/generic + +# Defaults for settings controlled by this script +export GENERATE_DOCSET="NO"; +export GENERATE_HTML="NO"; +export GENERATE_HTMLHELP="NO"; +export GENERATE_LATEX="NO"; +export GENERATE_QHP="NO"; +export GENERATE_XML="NO"; +export SEARCHENGINE="NO"; +export SERVER_BASED_SEARCH="NO"; + +# Which format should we generate during this run? +case "$1" in + all) # All *main* formats, not all formats, here for backwards compat. + export GENERATE_HTML="YES"; + export GENERATE_HTMLHELP="YES"; + export GENERATE_XML="YES"; + ;; + chm) + export GENERATE_HTML="YES"; + export GENERATE_HTMLHELP="YES"; + ;; + docset) + export GENERATE_DOCSET="YES"; + export GENERATE_HTML="YES"; + ;; + latex) + export GENERATE_LATEX="YES"; + ;; + php) # HTML, but with PHP Search Engine + export GENERATE_HTML="YES"; + export SEARCHENGINE="YES"; + export SERVER_BASED_SEARCH="YES"; + ;; + qch) + export GENERATE_HTML="YES"; + export GENERATE_QHP="YES"; + ;; + xml) + export GENERATE_XML="YES"; + ;; + *) # Default to HTML only + export GENERATE_HTML="YES"; + export SEARCHENGINE="YES"; + ;; +esac # # NOW RUN DOXYGEN @@ -54,7 +113,7 @@ fi # otherwise when generating the CHM file with Doxygen, those files are # not included! # -doxygen $cfgfile +$DOXYGEN Doxyfile if [[ "$1" = "qch" ]]; then # we need to add missing files to the .qhp @@ -104,15 +163,42 @@ if [[ "$1" = "qch" ]]; then qhelpgenerator out/html/index.qhp -o out/wx.qch fi +if [[ "$1" = "docset" ]]; then + DOCSETNAME="org.wxwidgets.doxygen.wx29.docset" + ATOM="org.wxwidgets.doxygen.docset.wx29.atom" + ATOMDIR="http://docs.wxwidgets.org/docsets" + XAR="org.wxwidgets.doxygen.docset.wx29.xar" + XARDIR="http://docs.wxwidgets.org/docsets" + XCODE_INSTALL=`sh xcode-select -print-path` + + cd out/html + DESTINATIONDIR=`pwd` + + rm -rf $DESTINATIONDIR/$DOCSETNAME + rm -f $DESTINATIONDIR/$XAR + + make + + defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info CFBundleVersion 1.3 + defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info CFBundleShortVersionString 1.3 + defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info CFBundleName "wxWidgets 2.9 Library" + defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info DocSetFeedURL $ATOMDIR/$ATOM + defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info DocSetFallbackURL http://docs.wxwidgets.org + defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info DocSetDescription "API reference and conceptual documentation for wxWidgets 2.9" + defaults write $DESTINATIONDIR/$DOCSETNAME/Contents/Info NSHumanReadableCopyright "Copyright 1992-2012 wxWidgets team, Portions 1996 Artificial Intelligence Applications Institute" + + $XCODE_INSTALL/usr/bin/docsetutil package -atom $DESTINATIONDIR/$ATOM -download-url $XARDIR/$XAR -output $DESTINATIONDIR/$XAR $DESTINATIONDIR/$DOCSETNAME + + cd ../.. +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 currpath=`pwd`/ interfacepath=`cd ../../interface && pwd`/ -cat doxygen.log | sed -e "s|$currpath||g" -e "s|$interfacepath||g" >temp - -# Doxygen warnings are not completely sorted for filename; enforce correct sorting: -cat temp | sort >doxygen.log +cat doxygen.log | sed -e "s|$currpath||g" -e "s|$interfacepath||g" > temp +cat temp > doxygen.log rm temp # return to the original folder from which this script was launched