Skip to content

Commit

Permalink
Improve comments
Browse files Browse the repository at this point in the history
  • Loading branch information
lucacarniato committed Apr 30, 2024
1 parent d866cb8 commit af4894e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions libs/MeshKernelApi/include/MeshKernelApi/MeshKernel.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -1047,18 +1047,18 @@ namespace meshkernelapi
/// @returns Error code
MKERNEL_API int mkernel_mesh2d_get_hanging_edges(int meshKernelId, int* edges);

/// @brief Gets the faces polygons with a number of edges larger or equal to numEdges
/// @brief Gets the faces polygons with a number of edges larger or equal to numNodes
///
/// @param[in] meshKernelId The id of the mesh state
/// @param[in] numNodes The number of edges
/// @param[in] numNodes The number of nodes
/// @param[in] facePolygons The resulting face polygons
/// @returns Error code
MKERNEL_API int mkernel_mesh2d_get_face_polygons(int meshKernelId, int numNodes, GeometryList& facePolygons);

/// @brief Gets the dimension of faces polygons with a number of edges larger or equal to numEdges
/// @brief Gets the dimension of faces polygons with a number of edges larger or equal to numNodes
///
/// @param[in] meshKernelId The id of the mesh state
/// @param[in] numNodes The number of edges
/// @param[in] numNodes The number of nodes
/// @param[out] geometryListDimension The dimension of the geometry list containing the face polygons
/// @returns Error code
MKERNEL_API int mkernel_mesh2d_get_face_polygons_dimension(int meshKernelId, int numNodes, int& geometryListDimension);
Expand Down

0 comments on commit af4894e

Please sign in to comment.