From 6d59cc40a45c71576076de5921ee4a6e06c49bc1 Mon Sep 17 00:00:00 2001
From: Tobias Meisel <tobias.meisel@ufz.de>
Date: Tue, 6 Apr 2021 14:13:45 +0200
Subject: [PATCH] [MeL/IO] Add missing xdmf parameter documentation.
---
MeshLib/IO/XDMF/XdmfData.h | 1 +
MeshLib/IO/XDMF/transformData.h | 4 +++-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/MeshLib/IO/XDMF/XdmfData.h b/MeshLib/IO/XDMF/XdmfData.h
index 6bb86b6aa09..680f53e94b5 100644
--- a/MeshLib/IO/XDMF/XdmfData.h
+++ b/MeshLib/IO/XDMF/XdmfData.h
@@ -38,6 +38,7 @@ struct XdmfData
* @param size_tuple We assume there is at most a rank of 2 of data
* (properties). The size of tuple gives the length of the second dimension
* (index 1).
+ * @param mesh_property_data_type property vector data type.
* @param name The name of the attribute. It assumed to be unique.
* @param attribute_center XdmfData is used for topology, geometry and
* attributes. Geometry and topology have never a attribute_center.
diff --git a/MeshLib/IO/XDMF/transformData.h b/MeshLib/IO/XDMF/transformData.h
index 16babbce877..0484e2a801a 100644
--- a/MeshLib/IO/XDMF/transformData.h
+++ b/MeshLib/IO/XDMF/transformData.h
@@ -38,7 +38,9 @@ Geometry transformGeometry(MeshLib::Mesh const& mesh);
* The topology is specific to xdmf because it contains the xdmf cell types!!
* See section topology in https://www.xdmf.org/index.php/XDMF_Model_and_Format
* @param mesh OGS mesh can be mesh or partitionedMesh
+ * @param offset Local offset to transform local to global cell ID. Offset must
+ * be zero in serial and must be defined for each process in parallel execution.
* @return Topology containing a copy of the data and the topology meta data
*/
Topology transformTopology(MeshLib::Mesh const& mesh, std::size_t offset);
-} // namespace MeshLib::IO
\ No newline at end of file
+} // namespace MeshLib::IO
--
GitLab