From c580e30407d49e330092e6e52fb8f88cabc3f85c Mon Sep 17 00:00:00 2001 From: Sven Oesau Date: Mon, 19 Feb 2024 12:10:59 +0100 Subject: [PATCH] small doc update --- Orthtree/doc/Orthtree/Concepts/OrthtreeTraitsWithData.h | 2 +- Orthtree/include/CGAL/Orthtree.h | 2 +- Orthtree/include/CGAL/Orthtree/Nearest_neighbors.h | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Orthtree/doc/Orthtree/Concepts/OrthtreeTraitsWithData.h b/Orthtree/doc/Orthtree/Concepts/OrthtreeTraitsWithData.h index c67a1af8dc8..e3e5f5e6124 100644 --- a/Orthtree/doc/Orthtree/Concepts/OrthtreeTraitsWithData.h +++ b/Orthtree/doc/Orthtree/Concepts/OrthtreeTraitsWithData.h @@ -42,7 +42,7 @@ public: using Construct_root_node_contents = unspecified_type; /*! - * \brief functor which fills the contents of the nodes children. + * \brief Functor which fills the contents of the nodes children. * * Provides the operator: * `void operator()(typename Tree::Node_index, Tree&, const Point_d&)` diff --git a/Orthtree/include/CGAL/Orthtree.h b/Orthtree/include/CGAL/Orthtree.h index 2f8ffeb814b..af99d730eaf 100644 --- a/Orthtree/include/CGAL/Orthtree.h +++ b/Orthtree/include/CGAL/Orthtree.h @@ -724,7 +724,7 @@ public: } /*! - \brief determines whether the node specified by index `n` is a root node. + \brief determines whether the node specified by index `n` is the root node. */ bool is_root(Node_index n) const { return n == 0; diff --git a/Orthtree/include/CGAL/Orthtree/Nearest_neighbors.h b/Orthtree/include/CGAL/Orthtree/Nearest_neighbors.h index 3970a7235e2..fdcbe33eccb 100644 --- a/Orthtree/include/CGAL/Orthtree/Nearest_neighbors.h +++ b/Orthtree/include/CGAL/Orthtree/Nearest_neighbors.h @@ -119,7 +119,7 @@ namespace Orthtrees { \ingroup PkgOrthtreeNeighbors \brief finds at most `k` elements within a specific radius that are nearest to the center of the sphere `query`: if `query` does not contain - at least `k` elements, only contained points will be returned. + at least `k` elements, only contained elements will be returned. This function is useful when the user already knows how sparse the elements are, or if they do not care about elements that are too far away.