Remove one group layer

This commit is contained in:
Andreas Fabri 2024-01-15 07:40:55 +00:00
parent 8097ba81bc
commit f7eaa95099
7 changed files with 14 additions and 17 deletions

View File

@ -58,7 +58,7 @@ public:
* It should take no arguments, and return an instance of `Node_data`.
*
* Typically, the `Node_data` of the root node contains all the elements in the tree.
* For a tree in which each node contains an `std::span` this function would return the span containing all items.
* For a tree in which each node contains an `std::span()` this function would return the span containing all items.
*
*/
using Construct_root_node_contents = unspecified_type;
@ -67,7 +67,7 @@ public:
* \brief Functor to locate in which halfspace a number of type `FT` is located with respect to another number of type `FT`.
*
* The functor is used by `Orthtree::locate()` to identify in which leaf node a point is located.
* Distribute_node_contents should use `Locate_halfspace` to guarantee consistency wich `Orthtree::locate()`.
* `Distribute_node_contents` mustt use `Locate_halfspace` to guarantee consistency wich `Orthtree::locate()`.
*/
using Locate_halfspace = unspecified_type;
@ -84,10 +84,10 @@ public:
using Distribute_node_contents = unspecified_type;
/*!
* \brief Functor with an operator to construct a `Point_d` from an appropriate number of x, y, z etc. `FT` arguments.
* \brief Functor with an operator to construct a `Point_d` from an appropriate number of x, y, z etc.\ `FT` arguments.
*
* For trees which use a different kernel for the Bbox type,
* the return type of this functor must match the kernel used by the Bbox and not that of the contents.
* For trees which use a different kernel for the bounding box type,
* the return type of this functor must match the kernel used by the bounding box type and not that of the contents.
*/
using Construct_point_d = unspecified_type;

View File

@ -3,11 +3,11 @@
\ingroup PkgOrthtreeConcepts
\cgalConcept
\brief a traversal provides the functions needed to traverse the
\brief A traversal provides the functions needed to traverse the
nodes of an orthtree.
A traversal is used to iterate on a tree with a user-selected order
(e.g. preorder, postorder).
(e.g., preorder, postorder).
\cgalHasModelsBegin
\cgalHasModels{CGAL::Orthtrees::Preorder_traversal}

View File

@ -1,19 +1,16 @@
/// \defgroup PkgOrthtreeRef Quadtrees, Octrees and Orthtrees Reference
Quadtree, Octree and Orthtree Reference
/// \defgroup PkgOrthtreeClasses Classes
/// \defgroup PkgOrthtreeConcepts Concepts
/// \ingroup PkgOrthtreeRef
/// \defgroup PkgOrthtreeTraits Traits
/// \ingroup PkgOrthtreeClasses
/// \ingroup PkgOrthtreeRef
/// \defgroup PkgOrthtreeSplitPredicates Split Predicates
/// \ingroup PkgOrthtreeClasses
/// \ingroup PkgOrthtreeRef
/// \defgroup PkgOrthtreeTraversal Traversal
/// \ingroup PkgOrthtreeClasses
/// \defgroup PkgOrthtreeConcepts Concepts
/// \ingroup PkgOrthtreeRef
/// \defgroup PkgOrthtreeNeighbors Neighbor Search Functions

View File

@ -20,7 +20,7 @@
namespace CGAL {
/*!
\ingroup PkgOrthtreeClasses
\ingroup PkgOrthtreeRef
\brief Alias that specializes the `Orthtree` class to a 3D octree.

View File

@ -48,7 +48,7 @@
namespace CGAL {
/*!
\ingroup PkgOrthtreeClasses
\ingroup PkgOrthtreeRef
\brief A data structure using an axis-aligned hyperrectangle
decomposition of dD space for efficient access and

View File

@ -25,7 +25,7 @@
namespace CGAL {
/*!
* \ingroup PkgOrthtreeClasses
* \ingroup PkgOrthtreeTraversal
*
* \brief Wraps a traversal definition to produce an iterator which traverses the tree when incremented.
*

View File

@ -20,7 +20,7 @@
namespace CGAL {
/*!
\ingroup PkgOrthtreeClasses
\ingroup PkgOrthtreeRef
\brief Alias that specializes the `Orthtree` class to a 2D quadtree.