From c4c4b5b79dcbbf9b8cb9cd8bc014baa825b0f9f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Mon, 30 Nov 2020 18:48:37 +0100 Subject: [PATCH] Tiny doc improvements --- .../doc/Spatial_searching/Concepts/FuzzyQueryItem.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/FuzzyQueryItem.h b/Spatial_searching/doc/Spatial_searching/Concepts/FuzzyQueryItem.h index e7a8598c742..a8aa2640a2c 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/FuzzyQueryItem.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/FuzzyQueryItem.h @@ -36,27 +36,27 @@ typedef unspecified_type FT; /// @{ /*! -Test whether the query item contains `p`. +tests whether the query item contains `p`. */ bool contains(Point_d p) const; /*! -Optional: must be defined when used with a `Kd_tree` where `EnablePointsCache` -is set to `Tag_true`. -Test whether the query item contains the point whose Cartesian coordinates +\note Optional: must be defined when used with a `Kd_tree` where `EnablePointsCache` is set to `Tag_true`. + +tests whether the query item contains the point whose Cartesian coordinates are contained in the range [`begin`, `end`). */ template bool contains_point_given_as_coordinates(Coord_iterator begin, Coord_iterator end) const; /*! -Test whether the inner approximation of the spatial object intersects a rectangle +tests whether the inner approximation of the spatial object intersects a rectangle associated with a node of a tree. */ bool inner_range_intersects(const Kd_tree_rectangle& rectangle) const; /*! -Test whether the outer approximation of the spatial object encloses the rectangle +tests whether the outer approximation of the spatial object encloses the rectangle associated with a node of a tree. */ bool outer_range_contains(const Kd_tree_rectangle& rectangle) const;