From deeb23f62ead5062f799bb731bb040887b9c583f Mon Sep 17 00:00:00 2001
From: Dmitri Naumov <dmitri.naumov@ufz.de>
Date: Tue, 22 Nov 2016 19:33:55 +0100
Subject: [PATCH] [MeL] Add missing parameter documentation.
---
MeshLib/MeshGenerators/MeshGenerator.h | 30 ++++++++++++++++++--------
1 file changed, 21 insertions(+), 9 deletions(-)
diff --git a/MeshLib/MeshGenerators/MeshGenerator.h b/MeshLib/MeshGenerators/MeshGenerator.h
index b10b114a61a..57acefcd7c9 100644
--- a/MeshLib/MeshGenerators/MeshGenerator.h
+++ b/MeshLib/MeshGenerators/MeshGenerator.h
@@ -140,7 +140,9 @@ Mesh* generateRegularQuadMesh(const BaseLib::ISubdivision &div_x,
*
* \param length Mesh's dimensions in x- and y-directions.
* \param subdivision Number of subdivisions.
- * \param origin Optional mesh's origin (the lower left corner) with MathLib::ORIGIN default.
+ * \param origin Optional mesh's origin (the lower left corner) with
+ * MathLib::ORIGIN default.
+ * \param mesh_name Name of the new mesh.
*/
Mesh* generateRegularQuadMesh(const double length,
const std::size_t subdivision,
@@ -155,7 +157,9 @@ Mesh* generateRegularQuadMesh(const double length,
* \param y_length Mesh's dimension in y-direction.
* \param x_subdivision Number of subdivisions in x-direction.
* \param y_subdivision Number of subdivisions in y-direction.
- * \param origin Optional mesh's origin (the lower left corner) with MathLib::ORIGIN default.
+ * \param origin Optional mesh's origin (the lower left corner) with
+ * MathLib::ORIGIN default.
+ * \param mesh_name Name of the new mesh.
*/
Mesh* generateRegularQuadMesh(const double x_length,
const double y_length,
@@ -198,15 +202,15 @@ Mesh* generateRegularQuadMesh(const unsigned n_x_cells,
MathLib::Point3d const& origin = MathLib::ORIGIN,
std::string const& mesh_name = "mesh");
-
-
/**
* Generate a regular 3D Hex-Element mesh.
*
* \param div_x Subdivision operator in x direction
* \param div_y Subdivision operator in y direction
* \param div_z Subdivision operator in z direction
- * \param origin Optional mesh's origin (the bottom lower left corner) with MathLib::ORIGIN default.
+ * \param origin Optional mesh's origin (the bottom lower left corner) with
+ * MathLib::ORIGIN default.
+ * \param mesh_name Name of the new mesh.
*/
Mesh* generateRegularHexMesh(const BaseLib::ISubdivision &div_x,
const BaseLib::ISubdivision &div_y,
@@ -292,7 +296,9 @@ Mesh* generateRegularHexMesh(const unsigned n_x_cells,
*
* \param div_x Subdivision operator in x direction
* \param div_y Subdivision operator in y direction
- * \param origin Optional mesh's origin (the bottom lower left corner) with MathLib::ORIGIN default.
+ * \param origin Optional mesh's origin (the bottom lower left corner) with
+ * MathLib::ORIGIN default.
+ * \param mesh_name Name of the new mesh.
*/
Mesh* generateRegularTriMesh(const BaseLib::ISubdivision &div_x,
const BaseLib::ISubdivision &div_y,
@@ -305,7 +311,9 @@ Mesh* generateRegularTriMesh(const BaseLib::ISubdivision &div_x,
*
* \param length Mesh's dimensions in x- and y-directions.
* \param subdivision Number of subdivisions.
- * \param origin Optional mesh's origin (the lower left corner) with MathLib::ORIGIN default.
+ * \param origin Optional mesh's origin (the lower left corner) with
+ * MathLib::ORIGIN default.
+ * \param mesh_name Name of the new mesh.
*/
Mesh* generateRegularTriMesh(const double length,
const std::size_t subdivision,
@@ -320,7 +328,9 @@ Mesh* generateRegularTriMesh(const double length,
* \param y_length Mesh's dimension in y-direction.
* \param x_subdivision Number of subdivisions in x-direction.
* \param y_subdivision Number of subdivisions in y-direction.
- * \param origin Optional mesh's origin (the lower left corner) with MathLib::ORIGIN default.
+ * \param origin Optional mesh's origin (the lower left corner) with
+ * MathLib::ORIGIN default.
+ * \param mesh_name Name of the new mesh.
*/
Mesh* generateRegularTriMesh(const double x_length,
const double y_length,
@@ -372,7 +382,9 @@ Mesh* generateRegularTriMesh(const unsigned n_x_cells,
* \param x_subdivision Number of subdivisions in x-direction.
* \param y_subdivision Number of subdivisions in y-direction.
* \param z_subdivision Number of subdivisions in z-direction.
- * \param origin Optional mesh's origin (the lower left corner) with MathLib::ORIGIN default.
+ * \param origin Optional mesh's origin (the lower left corner) with
+ * MathLib::ORIGIN default.
+ * \param mesh_name Name of the new mesh.
*/
Mesh* generateRegularPrismMesh(const double x_length,
const double y_length,
--
GitLab