ENH: (further) Doxygen documentation updates for module support

applications/utilities/doc/utilities.dox

@@ -0,0 +1,37 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     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/>.
+
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+\page pageUtilities Utilities
+
+\section secUtilities Overview
+The available utilities are grouped into the following categories:
+  - \ref grpMeshUtilities
+  - \ref grpMiscUtilities
+  - \ref grpPreProcessingUtilities
+  - \ref grpPostProcessingUtilities
+  - \ref grpThermoUtilities
+  - \ref grpSurfaceUtilities
+
+\*---------------------------------------------------------------------------*/

applications/utilities/doc/utilitiesDoc.H

@@ -0,0 +1,73 @@
+/*---------------------------------------------------------------------------*\
+  =========                 |
+  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+   \\    /   O peration     |
+    \\  /    A nd           | Copyright (C) 2016 OpenCFD Ltd.
+     \\/     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 grpUtilities Utilities
+@{
+    This group contains utilities
+@}
+
+\defgroup grpMeshUtilities Mesh
+@{
+    \ingroup grpUtilities
+    This group contains meshing utilities
+@}
+
+\defgroup grpPreProcessingUtilities Pre-processing
+@{
+    \ingroup grpUtilities
+    This group contains pre-processing utilities
+@}
+
+\defgroup grpPostProcessingUtilities Post-processing
+@{
+    \ingroup grpUtilities
+    This group contains post-processing utilities
+@}
+
+\defgroup grpParallelUtilities Parallel
+@{
+    \ingroup grpUtilities
+    This group contains parallel utilities
+@}
+
+\defgroup grpSurfaceUtilities Surface
+@{
+    \ingroup grpUtilities
+    This group contains surface utilities
+@}
+
+\defgroup grpThermophysicalUtilities Thermophysical
+@{
+    \ingroup grpUtilities
+    This group contains thermophysical utilities
+@}
+
+\defgroup grpMiscUtilities Miscellaneous
+@{
+    \ingroup grpUtilities
+    This group contains miscellaneous utilities
+@}
+
+\*---------------------------------------------------------------------------*/