Update doxygen documentation

Deltares · Oct 17, 2023 · 8cc3af8 · 8cc3af8
1 parent 1dc476c
commit 8cc3af8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/libs/MeshKernel/include/MeshKernel/Mesh.hpp b/libs/MeshKernel/include/MeshKernel/Mesh.hpp
@@ -306,10 +306,10 @@ namespace meshkernel
         [[nodiscard]] std::vector<Point> ComputeLocations(Location location) const;
 
         /// @brief Computes if a location is in polygon.
-        /// @param[in] index The closest neighbor index (index 0 corresponds to the closest).
-        /// @param[in] meshLocation The mesh location (e.g. nodes, edge centers or face circumcenters).
+        /// @param[in] polygon The input polygon.
+        /// @param[in] location The mesh location (e.g. nodes, edge centers or face circumcenters).
         /// @return The index of the closest location.
-        [[nodiscard]] std::vector<bool> ComputeLocationInPolygon(const Polygons& polygon, Location location) const;
+        [[nodiscard]] std::vector<bool> IsLocationInPolygon(const Polygons& polygon, Location location) const;
 
         /// @brief Add meshes: result is a mesh composed of the additions
         /// firstMesh += secondmesh results in the second mesh being added to firstMesh

diff --git a/libs/MeshKernel/src/Mesh.cpp b/libs/MeshKernel/src/Mesh.cpp
@@ -276,7 +276,7 @@ void Mesh::MergeNodesInPolygon(const Polygons& polygon, double mergingDistance)
     // first filter the nodes in polygon
     std::vector<Point> filteredNodes(GetNumNodes());
     std::vector<UInt> originalNodeIndices(GetNumNodes(), constants::missing::uintValue);
-    const auto isNodeInPolygon = ComputeLocationInPolygon(polygon, Location::Nodes);
+    const auto isNodeInPolygon = IsLocationInPolygon(polygon, Location::Nodes);
 
     UInt index = 0;
     for (UInt i = 0; i < GetNumNodes(); ++i)
@@ -401,7 +401,7 @@ double Mesh::ComputeMinEdgeLength(const Polygons& polygon) const
     auto const numEdges = GetNumEdges();
     auto result = std::numeric_limits<double>::max();
 
-    const auto isNodeInPolygon = ComputeLocationInPolygon(polygon, Location::Nodes);
+    const auto isNodeInPolygon = IsLocationInPolygon(polygon, Location::Nodes);
     for (UInt e = 0; e < numEdges; e++)
     {
         const auto& [firstNode, secondNode] = m_edges[e];
@@ -897,7 +897,7 @@ std::vector<meshkernel::Point> Mesh::ComputeLocations(Location location) const
     return result;
 }
 
-std::vector<bool> Mesh::ComputeLocationInPolygon(const Polygons& polygon, Location location) const
+std::vector<bool> Mesh::IsLocationInPolygon(const Polygons& polygon, Location location) const
 {
     const auto locations = ComputeLocations(location);
     std::vector<bool> result(locations.size());