bin/tools/doxyFilt-top.awk

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