c1c6243c3e
- can run doxygen with an alternative Doxyfile, which is useful
when verifying generated content for particular classes.
Eg,
PATH/doc/Allwmake -dir $PWD
125 lines
2.9 KiB
Bash
Executable File
125 lines
2.9 KiB
Bash
Executable File
#!/bin/sh
|
|
cd ${0%/*} || exit 1 # Run from this directory
|
|
[ -d "$WM_PROJECT_DIR" ] || {
|
|
echo "Error (${0##*/}) : no \$WM_PROJECT_DIR found"
|
|
echo " Check your OpenFOAM environment and installation"
|
|
echo " WM_PROJECT_DIR=$WM_PROJECT_DIR"
|
|
exit 1
|
|
}
|
|
|
|
usage() {
|
|
exec 1>&2
|
|
while [ "$#" -ge 1 ]; do echo "$1"; shift; done
|
|
cat<<USAGE
|
|
|
|
usage: ${0##*/} [OPTION]
|
|
options:
|
|
-config name use alternative doxygen config
|
|
-dir name process given directory name directly
|
|
-online use links to the Github repositories instead of the
|
|
local source code
|
|
-help
|
|
|
|
USAGE
|
|
exit 1
|
|
}
|
|
|
|
# -----------------------------------------------------------------------------
|
|
|
|
defineURL() {
|
|
WEB_PATH="https://develop.openfoam.com"
|
|
FOAM_REPO_VERSION="$WM_PROJECT-plus"
|
|
|
|
case "$WM_PROJECT_VERSION" in
|
|
v[1-9][.0-9]*)
|
|
FOAM_REPO_TAG="$WM_PROJECT-$WM_PROJECT_VERSION"
|
|
;;
|
|
*)
|
|
FOAM_REPO_TAG="master"
|
|
;;
|
|
esac
|
|
|
|
export FOAM_BASE_REPO="$WEB_PATH/Development/$FOAM_REPO_VERSION"
|
|
export FOAM_ONLINE_REPO="$FOAM_BASE_REPO/blob/${FOAM_REPO_TAG}"
|
|
}
|
|
|
|
|
|
unset configName dirName
|
|
|
|
# Parse options
|
|
while [ "$#" -gt 0 ]
|
|
do
|
|
case "$1" in
|
|
-h | -help)
|
|
usage
|
|
;;
|
|
-config)
|
|
configName="$2"
|
|
[ -f "$configName" ] || {
|
|
# No such file. Try some common alternatives
|
|
for ending in $configName ".$configName" "-$configName"
|
|
do
|
|
if [ -f "Doxyfile$ending" ]
|
|
then
|
|
configName="Doxyfile$ending"
|
|
break
|
|
fi
|
|
done
|
|
}
|
|
[ -f "$configName" ] || {
|
|
echo "Could not resolve Doxyfile config: $configName" 1>&2
|
|
exit 1
|
|
}
|
|
shift
|
|
;;
|
|
-dir)
|
|
dirName="$2"
|
|
[ -d "$dirName" ] || {
|
|
echo "Could not resolve input directory: $dirName" 1>&2
|
|
exit 1
|
|
}
|
|
shift
|
|
;;
|
|
-online)
|
|
defineURL
|
|
;;
|
|
*)
|
|
usage "unknown option/argument: '$1'"
|
|
;;
|
|
esac
|
|
shift
|
|
done
|
|
|
|
|
|
#------------------------------------------------------------------------------
|
|
|
|
rm -rf latex man
|
|
|
|
# Remove html directory in background
|
|
mv html html-stagedRemove$$ 2> /dev/null
|
|
rm -rf html-stagedRemove$$ >/dev/null 2>&1 &
|
|
|
|
# Ensure that created files are readable by everyone
|
|
umask 22
|
|
|
|
if [ -n "$dirName" ]
|
|
then
|
|
# Create a temporary with only the specified directory
|
|
tmpConfig="${TMPDIR:-/tmp}/Doxyfile.$$"
|
|
trap 'rm -f $tmpConfig 2>/dev/null; exit 0' EXIT TERM INT
|
|
cat $PWD/Doxyfile > $tmpConfig
|
|
echo "INPUT = $dirName" >> $tmpConfig
|
|
doxygen $tmpConfig
|
|
else
|
|
doxygen $configName
|
|
fi
|
|
|
|
# Fix permissions (NB: '+X' and not '+x'!)
|
|
chmod -R a+rX html latex man 2>/dev/null
|
|
|
|
echo
|
|
echo "Done doxygen"
|
|
echo
|
|
|
|
#------------------------------------------------------------------------------
|