60 lines
2.0 KiB
Bash
Executable File
60 lines
2.0 KiB
Bash
Executable File
#!/bin/bash
|
|
#------------------------------------------------------------------------------
|
|
# ========= |
|
|
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
# \\ / O peration |
|
|
# \\ / A nd | www.openfoam.com
|
|
# \\/ M anipulation |
|
|
#------------------------------------------------------------------------------
|
|
# Copyright (C) 2011-2016 OpenFOAM Foundation
|
|
#------------------------------------------------------------------------------
|
|
# License
|
|
# This file is part of OpenFOAM, distributed under GPL-3.0-or-later.
|
|
#
|
|
# 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=${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
|
|
;;
|
|
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
|
|
|
|
#------------------------------------------------------------------------------
|