Skip to content

Commit

Permalink
Fix mismatched parameter names in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JacksonCampolattaro committed Sep 30, 2023
1 parent 6f86c93 commit 047a949
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
7 changes: 4 additions & 3 deletions Orthtree/include/CGAL/Orthtree.h
Original file line number Diff line number Diff line change
Expand Up @@ -757,6 +757,7 @@ class Orthtree {
\pre `!is_leaf()`
\param n index of the node to retrieve the child of
\param i in [0, 2^D) specifying the child to retrieve
\return the index of the `i`th child of node n
*/
Expand Down Expand Up @@ -1004,8 +1005,8 @@ class Orthtree {
/*!
\brief Helper function for calling `is_topology_equal` on the root nodes of two trees.
\param lhsTree an Orthtree
\param rhsTree another Orthtree
\param lhs an Orthtree
\param rhs another Orthtree
\return True if lhsTree and rhsTree have the same topology
*/
Expand Down Expand Up @@ -1111,7 +1112,7 @@ class Orthtree {
\brief equivalent to `adjacent_node()`, with an adjacency direction rather than a bitset.
\param n index of the node to find a neighbor of
\param direction which way to find the adjacent node relative to this one
\param adjacency which way to find the adjacent node relative to this one
*/
Maybe_node_index adjacent_node(Node_index n, Adjacency adjacency) const {
return adjacent_node(n, std::bitset<Dimension::value>(static_cast<int>(adjacency)));
Expand Down
3 changes: 3 additions & 0 deletions Orthtree/include/CGAL/Orthtree/Nearest_neighbors.h
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ namespace Orthtrees {
\tparam Tree must be an orthtree with traits which are a model of CollectionPartitioningOrthtreeTraits
\tparam OutputIterator must be a model of `OutputIterator` that accepts points
\param orthtree the tree to search within
\param query_sphere the region to search within
\param k the number of points to find
Expand Down Expand Up @@ -172,6 +173,7 @@ OutputIterator nearest_k_neighbors_in_radius(
\tparam Tree must be an orthtree with traits which are a model of CollectionPartitioningOrthtreeTraits
\tparam OutputIterator a model of `OutputIterator` that accept `Point_d` objects.
\param orthtree the tree to search within
\param query query point.
\param k number of neighbors.
Expand All @@ -193,6 +195,7 @@ OutputIterator nearest_neighbors(const Tree& orthtree, const typename Tree::Poin
\tparam Tree must be an orthtree with traits which are a model of CollectionPartitioningOrthtreeTraits
\tparam OutputIterator a model of `OutputIterator` that accept `Point_d` objects.
\param orthtree the tree to search within
\param query query sphere.
\param output output iterator.
Expand Down

0 comments on commit 047a949

Please sign in to comment.