From df54b9c8aba9e45cb9c83b06e61f9bb1006cf54e Mon Sep 17 00:00:00 2001
From: Dmitri Naumov <dmitri.naumov@ufz.de>
Date: Tue, 22 Nov 2016 17:42:17 +0100
Subject: [PATCH] [MeL] Add missing parameter documentation.
---
MeshLib/MeshEditing/MeshRevision.h | 19 +++++++++++--------
1 file changed, 11 insertions(+), 8 deletions(-)
diff --git a/MeshLib/MeshEditing/MeshRevision.h b/MeshLib/MeshEditing/MeshRevision.h
index 1d64c3b1cff..adaff5f1810 100644
--- a/MeshLib/MeshEditing/MeshRevision.h
+++ b/MeshLib/MeshEditing/MeshRevision.h
@@ -59,15 +59,18 @@ public:
std::vector<std::size_t> collapseNodeIndices(double eps) const;
/**
- * Create a new mesh where all nodes with a distance < eps from each other are collapsed.
- * Elements are adjusted accordingly and elements with nonplanar faces are subdivided into
- * geometrically correct elements.
- * @param eps Minimum distance for nodes not to be collapsed
- * @param min_elem_dim Minimum dimension of elements to be inserted into new mesh (i.e.
- * min_elem_dim=3 will prevent the new mesh to contain 2D elements)
+ * Create a new mesh where all nodes with a distance < eps from each other
+ * are collapsed.
+ * Elements are adjusted accordingly and elements with nonplanar faces are
+ * subdivided into geometrically correct elements.
+ * @param new_mesh_name New name.
+ * @param eps Minimum distance for nodes not to be collapsed
+ * @param min_elem_dim Minimum dimension of elements to be inserted into
+ * new mesh (i.e. min_elem_dim=3 will prevent the new
+ * mesh to contain 2D elements)
*/
- MeshLib::Mesh* simplifyMesh(const std::string &new_mesh_name, double eps,
- unsigned min_elem_dim = 1);
+ MeshLib::Mesh* simplifyMesh(const std::string& new_mesh_name, double eps,
+ unsigned min_elem_dim = 1);
/**
* Create a new mesh where all elements with nonplanar faces are subdivided into simpler
--
GitLab