doxyFilt

#!/bin/sh
#------------------------------------------------------------------------------
# =========                 |
# \\      /  F ield         | foam-extend: Open Source CFD
#  \\    /   O peration     | Version:     4.1
#   \\  /    A nd           | Web:         http://www.foam-extend.org
#    \\/     M anipulation  | For copyright notice see file Copyright
#------------------------------------------------------------------------------
# License
#     This file is part of foam-extend.
#
#     foam-extend 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.
#
#     foam-extend 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 foam-extend.  If not, see <http://www.gnu.org/licenses/>.
#
# 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
#------------------------------------------------------------------------------