Skip to content

Commit

Permalink
Add to doxygen comment on constructor
Browse files Browse the repository at this point in the history
  • Loading branch information
JacksonCampolattaro committed Jul 22, 2020
1 parent 00bfcc7 commit 8da19bb
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions Octree/include/CGAL/Octree/Node.h
Expand Up @@ -94,10 +94,15 @@ class Node {
/*!
* \brief Creates a new node, optionally as the child of a parent
*
* \todo This warrants further explanation
* If no parent is provided, the node created is assumed to be the root of a tree.
* This means that the parent reference is a nullptr, and the depth is zero.
* If a parent is provided, the node becomes the child of that parent.
* In that case, an index should be passed, telling this node its relationship to its parent.
* Depth and location are automatically determined in the constructor,
* and should generally be considered immutable after construction.
*
* \param parent
* \param index
* \param parent A reference to the node containing this one
* \param index This node's relationship to its parent
*/
explicit Node(Node<Point_index> *parent = nullptr, Index index = 0) : m_parent(parent), m_depth(0), m_location({0, 0, 0}) {

Expand Down

0 comments on commit 8da19bb

Please sign in to comment.