bin/tools/doxyFilt-ignore.awk

   1 # -----------------------------------------------------------------------------
   2 # =========                 |
   3 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4 #  \\    /   O peration     |
   5 #   \\  /    A nd           | Copyright held by original author
   6 #    \\/     M anipulation  |
   7 # -----------------------------------------------------------------------------
   8 # License
   9 #     This file is part of OpenFOAM.
  10 #
  11 #     OpenFOAM is free software; you can redistribute it and/or modify it
  12 #     under the terms of the GNU General Public License as published by the
  13 #     Free Software Foundation; either version 2 of the License, or (at your
  14 #     option) any later version.
  15 #
  16 #     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17 #     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18 #     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19 #     for more details.
  20 #
  21 #     You should have received a copy of the GNU General Public License
  22 #     along with OpenFOAM; if not, write to the Free Software Foundation,
  23 #     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24 #
  25 # Script
  26 #     doxyFilt-ignore.awk
  27 #
  28 # Description
  29 #     - Prefix file contents with doxygen @file tag and %filePath% tag
  30 #       that will be changed in a subsequent sed script
  31 #     - Surround the contents of an entire file with @cond / @endcond
  32 #       to skip documenting all classes/variables
  33 #
  34 # -----------------------------------------------------------------------------
  35 BEGIN {
  36    print "//! @file %filePath%"
  37    print "//! @cond OpenFOAMIgnoreAppDoxygen"
  38 }
  39
  40 { print }
  41
  42 END {
  43    print "//! @endcond OpenFOAMIgnoreAppDoxygen"
  44 }
  45 # -----------------------------------------------------------------------------