bin/tools/doxyFilter-top.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-top.awk
  26 #
  27 # Description
  28 #     Only output the first /* ... */ comment section found in the file
  29 #     Use @cond / @endcond to suppress documenting all classes/variables
  30 #     - This is useful for application files in which only the first
  31 #       block documents the application itself.
  32 #
  33 # -----------------------------------------------------------------------------
  34 BEGIN {
  35     state = 0
  36 }
  37
  38 # a '/*' at the beginning of a line starts a comment block
  39 /^ *\/\*/ {
  40    state++
  41 }
  42
  43 # check first line
  44 # either started with a comment or skip documentation for the whole file
  45 FNR == 1 {
  46    if (!state)
  47    {
  48       print "//! @cond OpenFOAMIgnoreAppDoxygen"
  49       state = 2
  50    }
  51 }
  52
  53 # a '*/' ends the comment block
  54 # skip documentation for rest of the file
  55 /\*\// {
  56     if (state == 1)
  57     {
  58         print
  59         print "//! @cond OpenFOAMIgnoreAppDoxygen"
  60     }
  61     state = 2
  62     next
  63 }
  64
  65 # print everything within the first comment block
  66 {
  67     if (state)
  68     {
  69         print
  70     }
  71     next
  72 }
  73
  74 END {
  75     if (state == 2)
  76     {
  77         print "//! @endcond"
  78     }
  79 }
  80
  81 # -----------------------------------------------------------------------------