From f1f261afa101a762d1a002eb029920d6158676a8 Mon Sep 17 00:00:00 2001 From: andy <andy> Date: Thu, 19 Jul 2012 15:11:27 +0100 Subject: [PATCH] ENH: Added 'Group' option to doxygen sed filter --- bin/tools/doxyFilter.sed | 11 +++++++ .../doc/regionBoundaryConditionsDoc.H | 31 +++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 src/regionModels/doc/regionBoundaryConditionsDoc.H diff --git a/bin/tools/doxyFilter.sed b/bin/tools/doxyFilter.sed index b1bbfc20de3..67ba9d7eba7 100644 --- a/bin/tools/doxyFilter.sed +++ b/bin/tools/doxyFilter.sed @@ -64,6 +64,17 @@ s/^ /\\class / } +# Group +# groupName +# => +# \ingroup namespaceName +# +/^Group *$/,/^[^ ]/{ +s/^Group// +s/^ /\\ingroup / +} + + # Namespace # namespaceName # => diff --git a/src/regionModels/doc/regionBoundaryConditionsDoc.H b/src/regionModels/doc/regionBoundaryConditionsDoc.H new file mode 100644 index 00000000000..7f4981d4adf --- /dev/null +++ b/src/regionModels/doc/regionBoundaryConditionsDoc.H @@ -0,0 +1,31 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation + \\/ M anipulation | +------------------------------------------------------------------------------- +License + This file is part of OpenFOAM. + + OpenFOAM is free software: you can redistribute it and/or modify it under + the terms of the GNU General Public License as published by the Free + Software Foundation, either version 3 of the License, or (at your option) + any later version. + + OpenFOAM is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + details. + + You should have received a copy of the GNU General Public License along with + OpenFOAM. If not, see <http://www.gnu.org/licenses/>. + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpRegionBoundaryConditions Region boundary conditions +@{ + This group contains region model boundary conditions +@} + +\*---------------------------------------------------------------------------*/ -- GitLab