bin/doxyFilt

   1 #!/bin/sh
   2 #------------------------------------------------------------------------------
   3 # =========                 |
   4 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   5 #  \\    /   O peration     |
   6 #   \\  /    A nd           | Copyright held by original author
   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 the
  14 #     Free Software Foundation; either version 2 of the License, or (at your
  15 #     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, write to the Free Software Foundation,
  24 #     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  25 #
  26 # Script
  27 #     doxyFilt
  28 #
  29 # Description
  30 #     pass-through filter for doxygen
  31 #
  32 #     Special treatment for applications/{solvers,utilities}/*.C
  33 #     - only keep the first comment block of the C source file
  34 #       use @cond / @endcond to suppress documenting all classes/variables
  35 #
  36 #     Special treatment for applications/{solvers,utilities}/*.H
  37 #     - use @cond / @endcond to suppress documenting all classes/variables
  38 #------------------------------------------------------------------------------
  39
  40 if [ "$#" -gt 0 ]
  41 then
  42     filePath=$(echo $1 | sed -e s@^$WM_PROJECT_DIR@../../..@ )
  43     # dirName=$(echo "$filePath" | sed -e 's@/[^/]*$@@' )
  44     dirName=${filePath%/[^/]*}
  45     fileName=${filePath##*/}
  46
  47     awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilt.awk
  48
  49     case "$1" in
  50     */applications/solvers/*.C | */applications/utilities/*.C )
  51         awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilt-top.awk
  52         ;;
  53 #    */applications/solvers/*.H | */applications/utilities/*.H )
  54 #        awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilt-ignore.awk
  55 #        ;;
  56    esac
  57
  58     awk -f $awkScript $1 | \
  59     sed -f $WM_PROJECT_DIR/bin/tools/doxyFilt.sed \
  60         -e s@%filePath%@$filePath@g \
  61         -e s@%fileName%@$fileName@g \
  62         -e s@%dirName%@$dirName@g
  63 fi
  64 #------------------------------------------------------------------------------