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

small doc corrections

This commit is contained in:
Sven Oesau 2024-01-30 14:34:37 +01:00
parent ffb32d95a0
commit 546c0c842a
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -264,14 +264,14 @@ public:
/*! /*!
\brief recursively subdivides the orthtree until it meets the given criteria. \brief recursively subdivides the orthtree until it meets the given criteria.
The split predicate should return `true` if the node should be split and false` otherwise. The split predicate should return `true` if a leaf node should be split and false` otherwise.
This function may be called several times with different This function may be called several times with different
predicates: in that case, nodes already split are left unaltered, predicates: in that case, nodes already split are left unaltered,
while nodes that were not split and for which `split_predicate` while nodes that were not split and for which `split_predicate`
returns `true` are split. returns `true` are split.
\param split_predicate determines whether or not a node needs to be subdivided. \param split_predicate determines whether or not a leaf node needs to be subdivided.
*/ */
void refine(const Split_predicate& split_predicate) { void refine(const Split_predicate& split_predicate) {
@ -402,10 +402,10 @@ public:
const Traits& traits() const { return m_traits; } const Traits& traits() const { return m_traits; }
/*! /*!
\brief provides read-only access to the root node, and by \brief provides access to the root node, and by
extension the rest of the tree. extension the rest of the tree.
\return a const reference to the root node of the tree. \return Node_index of the root node.
*/ */
Node_index root() const { return 0; } Node_index root() const { return 0; }

2
Orthtree/include/CGAL/Orthtree/Traversals.h
View File

@ -105,7 +105,7 @@ public:
\tparam Tree an instance of `Orthtree` \tparam Tree an instance of `Orthtree`
All non-leave nodes are ignored. All non-leaf nodes are ignored.
\cgalModels{OrthtreeTraversal} \cgalModels{OrthtreeTraversal}
*/ */