mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
03b5d5c108
- Can occur with some user names, or mounted paths. Resolve by using '?' for the separation character. Since '?' is a shell-glob, it is highly unlikely to occur appear in filenames. Additionally, it is not a meta-character in standard sed, nor in the GNU extension (which uses '\?').
74 lines
2.7 KiB
Bash
Executable File
74 lines
2.7 KiB
Bash
Executable File
#!/bin/bash
|
|
#------------------------------------------------------------------------------
|
|
# ========= |
|
|
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
# \\ / O peration |
|
|
# \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
|
|
# \\/ M anipulation |
|
|
#------------------------------------------------------------------------------
|
|
# License
|
|
# This file is part of OpenFOAM.
|
|
#
|
|
# OpenFOAM is free software: you can redistribute it and/or modify it
|
|
# under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
|
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
# for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
# Script
|
|
# doxyFilter
|
|
#
|
|
# Description
|
|
# pass-through filter for doxygen
|
|
#
|
|
# Special treatment for applications/{solvers,utilities}/*.C
|
|
# - only keep the first comment block of the C source file
|
|
# use @cond / @endcond to suppress documenting all classes/variables
|
|
#
|
|
# Special treatment for applications/{solvers,utilities}/*.H
|
|
# - use @cond / @endcond to suppress documenting all classes/variables
|
|
#------------------------------------------------------------------------------
|
|
|
|
if [ "$#" -gt 0 ]
|
|
then
|
|
|
|
realFilePath=$(echo "$1" | sed -e "s?^$WM_PROJECT_DIR?../../..?" )
|
|
if [ -n "$FOAM_ONLINE_REPO" ]
|
|
then
|
|
filePath=$(echo "$1" | sed -e "s?^$WM_PROJECT_DIR?$FOAM_ONLINE_REPO?" )
|
|
else
|
|
filePath=$realFilePath
|
|
fi
|
|
|
|
# dirName=$(echo "$filePath" | sed -e 's?/[^/]*$??' )
|
|
dirName=${filePath%/[^/]*}
|
|
fileName=${filePath##*/}
|
|
|
|
awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilter.awk
|
|
|
|
case "$1" in
|
|
*/applications/solvers/*.C | */applications/utilities/*.C )
|
|
awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilter-top.awk
|
|
;;
|
|
# */applications/solvers/*.H | */applications/utilities/*.H )
|
|
# awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilter-ignore.awk
|
|
# ;;
|
|
esac
|
|
|
|
awk -f $WM_PROJECT_DIR/bin/tools/doxyFilter-table.awk "$1" | \
|
|
awk -f $awkScript | \
|
|
sed -f $WM_PROJECT_DIR/bin/tools/doxyFilter.sed \
|
|
-e s@%realFilePath%@$realFilePath@g \
|
|
-e s@%filePath%@$filePath@g \
|
|
-e s@%fileName%@$fileName@g \
|
|
-e s@%dirName%@$dirName@g
|
|
fi
|
|
#------------------------------------------------------------------------------
|