#!/bin/sh #------------------------------------------------------------------------------ # ========= | # \\ / F ield | OpenFOAM: The Open Source CFD Toolbox # \\ / O peration | # \\ / A nd | Copyright held by original author # \\/ 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 2 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, write to the Free Software Foundation, # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA # # Script # doxyFilt # # 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 filePath=$(echo $1 | sed -e s@^$WM_PROJECT_DIR@../../..@ ) # dirName=$(echo "$filePath" | sed -e 's@/[^/]*$@@' ) dirName=${filePath%/[^/]*} fileName=${filePath##*/} awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilt.awk case "$1" in */applications/solvers/*.C | */applications/utilities/*.C ) awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilt-top.awk ;; # */applications/solvers/*.H | */applications/utilities/*.H ) # awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilt-ignore.awk # ;; esac awk -f $awkScript $1 | \ sed -f $WM_PROJECT_DIR/bin/tools/doxyFilt.sed \ -e s@%filePath%@$filePath@g \ -e s@%fileName%@$fileName@g \ -e s@%dirName%@$dirName@g fi #------------------------------------------------------------------------------