From 11b33cfa95d9d57bd19b1d9faeb341274012e74e Mon Sep 17 00:00:00 2001
From: Norihiro Watanabe <norihiro.watanabe@ufz.de>
Date: Mon, 17 Mar 2014 19:35:02 +0100
Subject: [PATCH] documented where is the location of the origin
---
MeshLib/MeshGenerators/MeshGenerator.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/MeshLib/MeshGenerators/MeshGenerator.h b/MeshLib/MeshGenerators/MeshGenerator.h
index bafa374f3f3..cfefa948ef7 100644
--- a/MeshLib/MeshGenerators/MeshGenerator.h
+++ b/MeshLib/MeshGenerators/MeshGenerator.h
@@ -26,7 +26,7 @@ namespace MeshGenerator
*
* \param length Mesh's length in x-direction.
* \param subdivision Number of subdivisions.
- * \param origin Optional mesh's origin with GeoLib::ORIGIN default.
+ * \param origin Optional mesh's origin (the most left point) with GeoLib::ORIGIN default.
*/
Mesh* generateLineMesh(const double length,
const std::size_t subdivision,
@@ -38,7 +38,7 @@ Mesh* generateLineMesh(const double length,
*
* \param length Mesh's dimensions in x- and y-directions.
* \param subdivision Number of subdivisions.
- * \param origin Optional mesh's origin with GeoLib::ORIGIN default.
+ * \param origin Optional mesh's origin (the lower left corner) with GeoLib::ORIGIN default.
*/
Mesh* generateRegularQuadMesh(const double length,
const std::size_t subdivision,
@@ -49,7 +49,7 @@ Mesh* generateRegularQuadMesh(const double length,
*
* \param length Mesh's dimensions in x- and y- and z-directions.
* \param subdivision Number of subdivisions.
- * \param origin Optional mesh's origin with GeoLib::ORIGIN default.
+ * \param origin Optional mesh's origin (the bottom lower left corner) with GeoLib::ORIGIN default.
*/
Mesh* generateRegularHexMesh(const double length,
const std::size_t subdivision,
--
GitLab