diff options
author | cjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-06-30 15:48:13 +0000 |
---|---|---|
committer | cjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2016-06-30 15:48:13 +0000 |
commit | b2efeb519cdb43e407be5d1c0834c5cb39cc216a (patch) | |
tree | 87b4dd8f2be93e3aa1144a09bb6ea18c80a68782 /src/Spatial_searching/include | |
parent | bb0c62817f0c253c0931214180d75d3bf5f9ac43 (diff) |
Doc improvements
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/subsampling_and_spatialsearching@1368 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: a55a3d2b3c378a5a6347963b40976e50a8ee7816
Diffstat (limited to 'src/Spatial_searching/include')
-rw-r--r-- | src/Spatial_searching/include/gudhi/Spatial_tree_data_structure.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/Spatial_searching/include/gudhi/Spatial_tree_data_structure.h b/src/Spatial_searching/include/gudhi/Spatial_tree_data_structure.h index 18fb864a..016975b8 100644 --- a/src/Spatial_searching/include/gudhi/Spatial_tree_data_structure.h +++ b/src/Spatial_searching/include/gudhi/Spatial_tree_data_structure.h @@ -81,7 +81,7 @@ public: typedef CGAL::Orthogonal_k_neighbor_search<STraits> K_neighbor_search; typedef typename K_neighbor_search::Tree Tree; typedef typename K_neighbor_search::Distance Distance; - /// The range returned by a k-nearest neighbor search. + /// \brief The range returned by a k-nearest neighbor search. /// Its value type is `std::pair<std::size_t, FT>` where `first` is the index /// of a point P and `second` is the squared distance between P and the query point. typedef K_neighbor_search KNS_range; @@ -89,7 +89,7 @@ public: typedef CGAL::Orthogonal_incremental_neighbor_search< STraits, Distance, CGAL::Sliding_midpoint<STraits>, Tree> Incremental_neighbor_search; - /// The range returned by an incremental nearest neighbor search. + /// \brief The range returned by an incremental nearest neighbor search. /// Its value type is `std::pair<std::size_t, FT>` where `first` is the index /// of a point P and `second` is the squared distance between P and the query point. typedef Incremental_neighbor_search INS_range; |