bin/tools/doxyFilter-ignore.awk

   1 # -----------------------------------------------------------------------------
   2 # =========                 |
   3 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4 #  \\    /   O peration     |
   5 #   \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
   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
  13 #     the Free Software Foundation, either version 3 of the License, or
  14 #     (at your 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, see <http://www.gnu.org/licenses/>.
  23 #
  24 # Script
  25 #     doxyFilter-ignore.awk
  26 #
  27 # Description
  28 #     - Prefix file contents with doxygen @file tag and %filePath% tag
  29 #       that will be changed in a subsequent sed script
  30 #     - Surround the contents of an entire file with @cond / @endcond
  31 #       to skip documenting all classes/variables
  32 #
  33 # -----------------------------------------------------------------------------
  34 BEGIN {
  35    print "//! @file %filePath%"
  36    print "//! @cond OpenFOAMIgnoreAppDoxygen"
  37 }
  38
  39 { print }
  40
  41 END {
  42    print "//! @endcond"
  43 }
  44 # -----------------------------------------------------------------------------