bin/tools/doxyFilter

   1 #!/bin/sh
   2 #------------------------------------------------------------------------------
   3 # =========                 |
   4 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   5 #  \\    /   O peration     |
   6 #   \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
   7 #    \\/     M anipulation  |
   8 #-------------------------------------------------------------------------------
   9 # License
  10 #     This file is part of OpenFOAM.
  11 #
  12 #     OpenFOAM is free software: you can redistribute it and/or modify it
  13 #     under the terms of the GNU General Public License as published by
  14 #     the Free Software Foundation, either version 3 of the License, or
  15 #     (at your option) any later version.
  16 #
  17 #     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  18 #     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 #     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20 #     for more details.
  21 #
  22 #     You should have received a copy of the GNU General Public License
  23 #     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  24 #
  25 # Script
  26 #     doxyFilter
  27 #
  28 # Description
  29 #     pass-through filter for doxygen
  30 #
  31 #     Special treatment for applications/{solvers,utilities}/*.C
  32 #     - only keep the first comment block of the C source file
  33 #       use @cond / @endcond to suppress documenting all classes/variables
  34 #
  35 #     Special treatment for applications/{solvers,utilities}/*.H
  36 #     - use @cond / @endcond to suppress documenting all classes/variables
  37 #------------------------------------------------------------------------------
  38
  39 if [ "$#" -gt 0 ]
  40 then
  41     filePath=$(echo $1 | sed -e s@^$WM_PROJECT_DIR@../../..@ )
  42     # dirName=$(echo "$filePath" | sed -e 's@/[^/]*$@@' )
  43     dirName=${filePath%/[^/]*}
  44     fileName=${filePath##*/}
  45
  46     awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilter.awk
  47
  48     case "$1" in
  49     */applications/solvers/*.C | */applications/utilities/*.C )
  50         awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilter-top.awk
  51         ;;
  52 #    */applications/solvers/*.H | */applications/utilities/*.H )
  53 #        awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilter-ignore.awk
  54 #        ;;
  55     esac
  56
  57     awk -f $awkScript $1 | \
  58     sed -f $WM_PROJECT_DIR/bin/tools/doxyFilter.sed \
  59         -e s@%filePath%@$filePath@g \
  60         -e s@%fileName%@$fileName@g \
  61         -e s@%dirName%@$dirName@g
  62 fi
  63 #------------------------------------------------------------------------------