Add doxygen comment to Self typedef

CGAL · Aug 14, 2020 · 5e02c55 · 5e02c55
1 parent 100882c
commit 5e02c55
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/Octree/include/CGAL/Octree/Node.h b/Octree/include/CGAL/Octree/Node.h
@@ -42,6 +42,9 @@ class Node {
   /// \name Types
   /// @{
 
+  /*!
+   * \brief self typedef for convenience
+   */
   typedef Node<Point_index> Self;
 
   /*!
@@ -285,7 +288,7 @@ class Node {
    */
   bool is_root() const { return (!m_parent); }
 
-  /**
+  /*!
    * \brief find the directly adjacent node in a specific direction
    *
    * Adjacent nodes are found according to several properties:
@@ -378,21 +381,21 @@ class Node {
 
   }
 
-  /**
+  /*!
    * \todo I need to get copydoc working so I don't have to duplicate documentation
    */
   const Self *adjacent_node(Direction direction) const {
     return adjacent_node(std::bitset<3>(static_cast<int>(direction)));
   }
 
-  /**
+  /*!
    * \todo I need to get copydoc working so I don't have to duplicate documentation
    */
   Self *adjacent_node(std::bitset<3> direction) {
     return const_cast<Self *>(const_cast<const Self *>(this)->adjacent_node(direction));
   }
 
-  /**
+  /*!
    * \todo I need to get copydoc working so I don't have to duplicate documentation
    */
   Self *adjacent_node(Direction direction) {