More documentation fixes in tree-based containers, to make root() documentation available.

doc/intrusive.qbk

@@ -3847,6 +3847,7 @@ to be inserted in intrusive containers are allocated using `std::vector` or `std
    *  [@https://svn.boost.org/trac/boost/ticket/12432 Boost Trac #12432: ['Forced KeyOfValue creation when using custom compare on insert_check]]
 
 *  Implemented `merge` functions in ordered associative containers.
+*  Officially documented `root()` function for tree-based containers.
 
 [endsect]
 

include/boost/intrusive/avl_set.hpp

@@ -155,6 +155,15 @@ class avl_set_impl
    //! @copydoc ::boost::intrusive::avltree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::avltree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::avltree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::avltree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::avltree::container_from_end_iterator(iterator)
    static avl_set_impl &container_from_end_iterator(iterator end_iterator);
 
@@ -683,6 +692,15 @@ class avl_multiset_impl
    //! @copydoc ::boost::intrusive::avltree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::avltree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::avltree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::avltree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::avltree::container_from_end_iterator(iterator)
    static avl_multiset_impl &container_from_end_iterator(iterator end_iterator);
 

include/boost/intrusive/avltree.hpp

@@ -189,6 +189,15 @@ class avltree_impl
    //! @copydoc ::boost::intrusive::bstree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::bstree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::bstree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::bstree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::bstree::container_from_end_iterator(iterator)
    static avltree_impl &container_from_end_iterator(iterator end_iterator);
 

include/boost/intrusive/bs_set.hpp

@@ -152,6 +152,15 @@ class bs_set_impl
    //! @copydoc ::boost::intrusive::bstree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::bstree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::bstree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::bstree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::bstree::container_from_end_iterator(iterator)
    static bs_set_impl &container_from_end_iterator(iterator end_iterator);
 
@@ -679,6 +688,15 @@ class bs_multiset_impl
    //! @copydoc ::boost::intrusive::bstree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::bstree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::bstree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::bstree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::bstree::container_from_end_iterator(iterator)
    static bs_multiset_impl &container_from_end_iterator(iterator end_iterator);
 

include/boost/intrusive/rbtree.hpp

@@ -188,6 +188,15 @@ class rbtree_impl
    //! @copydoc ::boost::intrusive::bstree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::bstree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::bstree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::bstree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::bstree::container_from_end_iterator(iterator)
    static rbtree_impl &container_from_end_iterator(iterator end_iterator);
 

include/boost/intrusive/set.hpp

@@ -155,6 +155,15 @@ class set_impl
    //! @copydoc ::boost::intrusive::rbtree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::rbtree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::rbtree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::rbtree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::rbtree::container_from_end_iterator(iterator)
    static set_impl &container_from_end_iterator(iterator end_iterator);
 
@@ -683,6 +692,15 @@ class multiset_impl
    //! @copydoc ::boost::intrusive::rbtree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::rbtree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::rbtree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::rbtree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::rbtree::container_from_end_iterator(iterator)
    static multiset_impl &container_from_end_iterator(iterator end_iterator);
 

include/boost/intrusive/sg_set.hpp

@@ -153,6 +153,15 @@ class sg_set_impl
    //! @copydoc ::boost::intrusive::sgtree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::sgtree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::sgtree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::sgtree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::sgtree::container_from_end_iterator(iterator)
    static sg_set_impl &container_from_end_iterator(iterator end_iterator);
 
@@ -692,6 +701,15 @@ class sg_multiset_impl
    //! @copydoc ::boost::intrusive::sgtree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::sgtree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::sgtree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::sgtree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::sgtree::container_from_end_iterator(iterator)
    static sg_multiset_impl &container_from_end_iterator(iterator end_iterator);
 

include/boost/intrusive/sgtree.hpp

@@ -382,6 +382,15 @@ class sgtree_impl
    //! @copydoc ::boost::intrusive::bstree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::bstree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::bstree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::bstree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::bstree::container_from_end_iterator(iterator)
    static sgtree_impl &container_from_end_iterator(iterator end_iterator);
 

include/boost/intrusive/splay_set.hpp

@@ -153,6 +153,15 @@ class splay_set_impl
    //! @copydoc ::boost::intrusive::splaytree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::splaytree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::splaytree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::splaytree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::splaytree::container_from_end_iterator(iterator)
    static splay_set_impl &container_from_end_iterator(iterator end_iterator);
 
@@ -704,6 +713,15 @@ class splay_multiset_impl
    //! @copydoc ::boost::intrusive::splaytree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::splaytree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::splaytree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::splaytree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::splaytree::container_from_end_iterator(iterator)
    static splay_multiset_impl &container_from_end_iterator(iterator end_iterator);
 

include/boost/intrusive/splaytree.hpp

@@ -183,6 +183,15 @@ class splaytree_impl
    //! @copydoc ::boost::intrusive::bstree::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::bstree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::bstree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::bstree::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::bstree::container_from_end_iterator(iterator)
    static splaytree_impl &container_from_end_iterator(iterator end_iterator);
 

include/boost/intrusive/treap.hpp

@@ -274,6 +274,16 @@ class treap_impl
 
    //! @copydoc ::boost::intrusive::bstree::crend()const
    const_reverse_iterator crend() const;
+
+   //! @copydoc ::boost::intrusive::bstree::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::bstree::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::bstree::croot()const
+   const_iterator croot() const;
+
    #endif
 
    //! <b>Effects</b>: Returns a reverse_iterator pointing to the highest priority object of the

include/boost/intrusive/treap_set.hpp

@@ -160,6 +160,15 @@ class treap_set_impl
    //! @copydoc ::boost::intrusive::treap::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::treap::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::treap::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::treap::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::treap::container_from_end_iterator(iterator)
    static treap_set_impl &container_from_end_iterator(iterator end_iterator);
 
@@ -706,6 +715,15 @@ class treap_multiset_impl
    //! @copydoc ::boost::intrusive::treap::crend()const
    const_reverse_iterator crend() const;
 
+   //! @copydoc ::boost::intrusive::treap::root()
+   iterator root();
+
+   //! @copydoc ::boost::intrusive::treap::root()const
+   const_iterator root() const;
+
+   //! @copydoc ::boost::intrusive::treap::croot()const
+   const_iterator croot() const;
+
    //! @copydoc ::boost::intrusive::treap::container_from_end_iterator(iterator)
    static treap_multiset_impl &container_from_end_iterator(iterator end_iterator);