45 lines
1.7 KiB
Awk
45 lines
1.7 KiB
Awk
|
# -----------------------------------------------------------------------------
|
||
|
|
# ========= |
|
||
|
|
# \\ / 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-ignore.awk
|
||
|
|
#
|
||
|
|
# Description
|
||
|
|
# - Prefix file contents with doxygen @file tag and %filePath% tag
|
||
|
|
# that will be changed in a subsequent sed script
|
||
|
|
# - Surround the contents of an entire file with @cond / @endcond
|
||
|
|
# to skip documenting all classes/variables
|
||
|
|
#
|
||
|
|
# -----------------------------------------------------------------------------
|
||
|
|
BEGIN {
|
||
|
|
print "//! @file %filePath%"
|
||
|
|
print "//! @cond OpenFOAMIgnoreAppDoxygen"
|
||
|
|
}
|
||
|
|
|
||
|
|
{ print }
|
||
|
|
|
||
|
|
END {
|
||
|
|
print "//! @endcond OpenFOAMIgnoreAppDoxygen"
|
||
|
|
}
|
||
|
|
# -----------------------------------------------------------------------------
|