Commit 8eee870f authored by Mark Olesen's avatar Mark Olesen
Browse files

STYLE: minor doxygen adjustments

parent a426a16a
...@@ -22,7 +22,7 @@ License ...@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::VRWGraph Foam::Module::VRWGraph
Description Description
This class is an implementation of a graph with variable column width. This class is an implementation of a graph with variable column width.
......
...@@ -22,7 +22,7 @@ License ...@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::graphConstRow Foam::Module::graphConstRow
Description Description
This class provides const access to a row of a graph This class provides const access to a row of a graph
......
...@@ -22,9 +22,10 @@ License ...@@ -22,9 +22,10 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::fpmaMesh Foam::Module::fpmaMesh
Description Description
General writer for AVL/FIRE fpma format.
SourceFiles SourceFiles
fpmaMesh.C fpmaMesh.C
......
...@@ -22,13 +22,15 @@ License ...@@ -22,13 +22,15 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::decomposeCells Foam::Module::decomposeCells
Description Description
Decomposes selected cells into pyramids Decomposes selected cells into pyramids
SourceFiles SourceFiles
decomposeCells.C
decomposeCellsDecomposition.C
decomposeCellsPyramids.C
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
......
...@@ -22,14 +22,12 @@ License ...@@ -22,14 +22,12 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::Modul::labelledScalar Foam::Module::labelledScalar
Description Description
A class containing point label and its coordinates. It is used for A class containing point label and its coordinates. It is used for
exchanging data over processors exchanging data over processors
SourceFiles
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef labelledScalar_H #ifndef labelledScalar_H
......
...@@ -22,14 +22,12 @@ License ...@@ -22,14 +22,12 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::Module::meshOctreCubeCoordinatesScalar Foam::Module::meshOctreeCubeCoordinatesScalar
Description Description
A class containing meshOctreeCubeCoordinates and a scalar value. A class containing meshOctreeCubeCoordinates and a scalar value.
It is used for exchanging data over processors It is used for exchanging data over processors
SourceFiles
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef meshOctreeCubeCoordinatesScalar_H #ifndef meshOctreeCubeCoordinatesScalar_H
......
...@@ -22,7 +22,7 @@ License ...@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::polyMeshGenFaces Foam::Module::polyMeshGenFaces
Description Description
Mesh with geometry and faces. It can be used for volume and surface meshes Mesh with geometry and faces. It can be used for volume and surface meshes
......
...@@ -22,7 +22,7 @@ License ...@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::triSurfPoints Foam::Module::triSurfPoints
Description Description
Point coordinates information for triangulated surface Point coordinates information for triangulated surface
......
...@@ -22,7 +22,7 @@ License ...@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::Module::bondaryLayerOptimisation Foam::Module::boundaryLayerOptimisation
Description Description
A class intended for improving quality of boundary layer cells. A class intended for improving quality of boundary layer cells.
......
...@@ -21,7 +21,7 @@ License ...@@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Namespace Class
Foam::Module::edgeExtractor Foam::Module::edgeExtractor
Description Description
......
...@@ -25,6 +25,7 @@ Class ...@@ -25,6 +25,7 @@ Class
Foam::Module::triSurface2DCheck Foam::Module::triSurface2DCheck
Description Description
triSurf 2D checks
SourceFiles SourceFiles
triSurface2DCheck.C triSurface2DCheck.C
......
...@@ -22,7 +22,7 @@ License ...@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::Module::triSurfaceCurvatureCalculator Foam::Module::triSurfaceCurvatureEstimator
Description Description
Provides information regarding surface partitions on the surface Provides information regarding surface partitions on the surface
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment