Reuse Doxygen comments for map::erase overloads
authorJonathan Wakely <jwakely@redhat.com>
Fri, 16 Dec 2016 18:13:20 +0000 (18:13 +0000)
committerJonathan Wakely <redi@gcc.gnu.org>
Fri, 16 Dec 2016 18:13:20 +0000 (18:13 +0000)
* include/bits/stl_map.h (map::erase(iterator)): Add Doxygen markup
to reuse documentation for erase(const_iterator) overload.
* include/bits/stl_multimap.h (multimap::erase(iterator)): Likewise.

From-SVN: r243758

libstdc++-v3/ChangeLog
libstdc++-v3/include/bits/stl_map.h
libstdc++-v3/include/bits/stl_multimap.h

index 0cf14b550ae7b5a8030a8d094cab7e4581edc404..0fc7832dc9480d10bdd6234d9e73dfc947f0aece 100644 (file)
@@ -1,5 +1,9 @@
 2016-12-16  Jonathan Wakely  <jwakely@redhat.com>
 
+       * include/bits/stl_map.h (map::erase(iterator)): Add Doxygen markup
+       to reuse documentation for erase(const_iterator) overload.
+       * include/bits/stl_multimap.h (multimap::erase(iterator)): Likewise.
+
        * include/bits/stl_tree.h (_Rb_tree::_M_erase_aux(const_iterator)):
        Add assertion for undefined argument.
        (_Rb_tree::_M_erase_aux(const_iterator, const_iterator)): Call
index bbd0a97f24359cf0c0370c54140c28d1151f91c8..2d8b8ec38b9384a0334a991addd06ad41f587a35 100644 (file)
@@ -999,6 +999,8 @@ _GLIBCXX_BEGIN_NAMESPACE_CONTAINER
        *  the element, and that if the element is itself a pointer,
        *  the pointed-to memory is not touched in any way.  Managing
        *  the pointer is the user's responsibility.
+       *
+       *  @{
        */
       iterator
       erase(const_iterator __position)
@@ -1009,6 +1011,7 @@ _GLIBCXX_BEGIN_NAMESPACE_CONTAINER
       iterator
       erase(iterator __position)
       { return _M_t.erase(__position); }
+      // @}
 #else
       /**
        *  @brief Erases an element from a %map.
index a5f775b468f053e58fada8a4704d0057302f45db..418b1f551c297c55eca31b8e5f96470aaa757142 100644 (file)
@@ -669,6 +669,8 @@ _GLIBCXX_BEGIN_NAMESPACE_CONTAINER
        *  and that if the element is itself a pointer, the pointed-to memory is
        *  not touched in any way.  Managing the pointer is the user's
        *  responsibility.
+       *
+       * @{
        */
       iterator
       erase(const_iterator __position)
@@ -679,6 +681,7 @@ _GLIBCXX_BEGIN_NAMESPACE_CONTAINER
       iterator
       erase(iterator __position)
       { return _M_t.erase(__position); }
+      // @}
 #else
       /**
        *  @brief Erases an element from a %multimap.