songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix mismatched parameter names in documentation

This commit is contained in:
JacksonCampolattaro 2023-09-30 09:24:20 +02:00
parent 6f86c932c8
commit 047a9494bd
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Orthtree/include/CGAL/Orthtree.h
View File

@ -757,6 +757,7 @@ public:
\pre `!is_leaf()` \pre `!is_leaf()`
\param n index of the node to retrieve the child of \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 \return the index of the `i`th child of node n
*/ */
@ -1004,8 +1005,8 @@ public:
/*! /*!
\brief Helper function for calling `is_topology_equal` on the root nodes of two trees. \brief Helper function for calling `is_topology_equal` on the root nodes of two trees.
\param lhsTree an Orthtree \param lhs an Orthtree
\param rhsTree another Orthtree \param rhs another Orthtree
\return True if lhsTree and rhsTree have the same topology \return True if lhsTree and rhsTree have the same topology
*/ */
@ -1111,7 +1112,7 @@ public:
\brief equivalent to `adjacent_node()`, with an adjacency direction rather than a bitset. \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 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 { Maybe_node_index adjacent_node(Node_index n, Adjacency adjacency) const {
return adjacent_node(n, std::bitset<Dimension::value>(static_cast<int>(adjacency))); return adjacent_node(n, std::bitset<Dimension::value>(static_cast<int>(adjacency)));

3
Orthtree/include/CGAL/Orthtree/Nearest_neighbors.h
View File

@ -129,6 +129,7 @@ namespace Orthtrees {
\tparam Tree must be an orthtree with traits which are a model of CollectionPartitioningOrthtreeTraits \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 \tparam OutputIterator must be a model of `OutputIterator` that accepts points
\param orthtree the tree to search within \param orthtree the tree to search within
\param query_sphere the region to search within \param query_sphere the region to search within
\param k the number of points to find \param k the number of points to find
@ -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 Tree must be an orthtree with traits which are a model of CollectionPartitioningOrthtreeTraits
\tparam OutputIterator a model of `OutputIterator` that accept `Point_d` objects. \tparam OutputIterator a model of `OutputIterator` that accept `Point_d` objects.
\param orthtree the tree to search within \param orthtree the tree to search within
\param query query point. \param query query point.
\param k number of neighbors. \param k number of neighbors.
@ -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 Tree must be an orthtree with traits which are a model of CollectionPartitioningOrthtreeTraits
\tparam OutputIterator a model of `OutputIterator` that accept `Point_d` objects. \tparam OutputIterator a model of `OutputIterator` that accept `Point_d` objects.
\param orthtree the tree to search within \param orthtree the tree to search within
\param query query sphere. \param query query sphere.
\param output output iterator. \param output output iterator.