openfoam/bin/doxyAwkTop
2008-04-15 18:56:58 +01:00

64 lines
1.9 KiB
Plaintext

# -----------------------------------------------------------------------------
# ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration |
# \\ / A nd | Copyright (C) 1991-2007 OpenCFD Ltd.
# \\/ 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
# doxyAwkTop
#
# Description
# Output only the first /* ... */ comment section found in the file
# - This is useful for application files in which only the first
# block documents the application itself and all other files simply
# pollute our documentation
#
# -----------------------------------------------------------------------------
BEGIN {
state = 0
}
# a '/*' at the beginning of a line starts a block
/^ *\/\*/ {
state++
}
# a '*/' ends the block
/\*\// {
if (state == 1)
{
print
}
state = 2
next
}
# end block
{
if (state == 1)
{
print
}
next
}
# -----------------------------------------------------------------------------