diff --git a/Orthtree/doc/Orthtree/Concepts/OrthtreeTraversal.h b/Orthtree/doc/Orthtree/Concepts/OrthtreeTraversal.h index 3a7d6b7a10d..1ecf1818db8 100644 --- a/Orthtree/doc/Orthtree/Concepts/OrthtreeTraversal.h +++ b/Orthtree/doc/Orthtree/Concepts/OrthtreeTraversal.h @@ -17,7 +17,7 @@ class OrthtreeTraversal { public: - using Node = unspecified_type; ///< An instance of `CGAL::Orthtree::Node` + using Node = unspecified_type; ///< An instance of [CGAL::Orthtree::Node](@ref CGAL::Orthtree::Node) /*! \brief returns the first node to iterate to, given the root of the Orthtree. diff --git a/Orthtree/doc/Orthtree/Orthtree.txt b/Orthtree/doc/Orthtree/Orthtree.txt index 8ce93fe9cc1..dbc91a5be88 100644 --- a/Orthtree/doc/Orthtree/Orthtree.txt +++ b/Orthtree/doc/Orthtree/Orthtree.txt @@ -152,7 +152,7 @@ In this case, we print out the nodes of the tree without indentation instead. \subsection Section_Orthtree_Custom_Traversal Custom Traversal Users can define their own traversal methods by creating models of the -`Traversal` concept. The following example shows how to define a +`OrthtreeTraversal` concept. The following example shows how to define a custom traversal that only traverses the first branch of the %octree: \cgalExample{Orthtree/octree_traversal_custom.cpp} diff --git a/Orthtree/include/CGAL/Orthtree.h b/Orthtree/include/CGAL/Orthtree.h index 4092135c5e5..9b5325e932a 100644 --- a/Orthtree/include/CGAL/Orthtree.h +++ b/Orthtree/include/CGAL/Orthtree.h @@ -431,7 +431,8 @@ public: This method allows to iterate on the nodes of the tree with a user-selected order (preorder, postorder, leaves only, etc.). - \tparam Traversal model of `Traversal` + \tparam Traversal model of `OrthtreeTraversal` that provides functions + compatible with the type of the orthree \param traversal \return a forward input iterator over the nodes of the tree */ diff --git a/Orthtree/include/CGAL/Orthtree/Split_predicates.h b/Orthtree/include/CGAL/Orthtree/Split_predicates.h index 9b774dd80c4..2f6f0d97eb4 100644 --- a/Orthtree/include/CGAL/Orthtree/Split_predicates.h +++ b/Orthtree/include/CGAL/Orthtree/Split_predicates.h @@ -22,7 +22,9 @@ namespace Orthtrees { /*! \ingroup PkgOrthtreeSplitPredicates - \brief bucket size predicate that splits a node if it contains more than a certain number of items. + \brief A class used to choose when a node should be split depending on the number of inliers. + + This is bucket size predicate that splits a node if it contains more than a certain number of items. */ class Maximum_number_of_inliers { @@ -38,7 +40,7 @@ public: /*! \brief returns `true` if `n` should be splitted, `false` otherwise. */ - template + template bool operator()(const Node &n) const { return (n.size() > m_bucket_size); } @@ -46,7 +48,9 @@ public: /*! \ingroup PkgOrthtreeSplitPredicates - \brief predicate that splits a node if its depth is lower than a certain limit. + \brief A class used to choose when a node should be split depending on the depth. + + This predicate makes a node splitted if its depth is lower than a certain limit. */ class Maximum_depth { @@ -62,7 +66,7 @@ public: /*! \brief returns `true` if `n` should be splitted, `false` otherwise. */ - template + template bool operator()(const Node &n) const { return n.depth() < m_max_depth; } @@ -70,8 +74,9 @@ public: /*! \ingroup PkgOrthtreeSplitPredicates + \brief A class used to choose when a node should be split depending on the depth and the number of inliers. - \brief predicate that splits a node if it contains more than a + This predicate makes a note splitted if it contains more than a certain number of items and if its depth is lower than a certain limit. */ @@ -90,7 +95,7 @@ public: /*! \brief returns `true` if `n` should be splitted, `false` otherwise. */ - template + template