OpenE2K
/
gcc
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

* include/bits/stl_iterator.h (reverse_iterator): Doxygen comments. 

From-SVN: r183182
This commit is contained in:
Jonathan Wakely 2012-01-14 17:47:18 +00:00 committed by Jonathan Wakely
parent 068ed5e0e1
commit af7b9e82d0
2 changed files with 37 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
libstdc++-v3/ChangeLog
View File

@ -1,3 +1,7 @@
2012-01-14 Jonathan Wakely <jwakely.gcc@gmail.com>
* include/bits/stl_iterator.h (reverse_iterator): Doxygen comments.
2012-01-13 François Dumont <fdumont@gcc.gnu.org> 2012-01-13 François Dumont <fdumont@gcc.gnu.org>
* include/bits/hashtable_policy.h (_Hash_node_base): New, use it as * include/bits/hashtable_policy.h (_Hash_node_base): New, use it as

59
libstdc++-v3/include/bits/stl_iterator.h
View File

@ -1,7 +1,7 @@
// Iterators -*- C++ -*- // Iterators -*- C++ -*-
// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, // Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
// 2010, 2011 // 2010, 2011, 2012
// Free Software Foundation, Inc. // Free Software Foundation, Inc.
// //
// This file is part of the GNU ISO C++ Library. This library is free // This file is part of the GNU ISO C++ Library. This library is free
@ -114,7 +114,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
typedef typename __traits_type::reference reference; typedef typename __traits_type::reference reference;
/** /**
* The default constructor default-initializes member @p current. * The default constructor value-initializes member @p current.
* If it is a pointer, that means it is zero-initialized. * If it is a pointer, that means it is zero-initialized.
*/ */
// _GLIBCXX_RESOLVE_LIB_DEFECTS // _GLIBCXX_RESOLVE_LIB_DEFECTS
@ -134,8 +134,8 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
: current(__x.current) { } : current(__x.current) { }
/** /**
* A reverse_iterator across other types can be copied in the normal * A %reverse_iterator across other types can be copied if the
* fashion. * underlying %iterator can be converted to the type of @c current.
*/ */
template<typename _Iter> template<typename _Iter>
reverse_iterator(const reverse_iterator<_Iter>& __x) reverse_iterator(const reverse_iterator<_Iter>& __x)
@ -149,9 +149,14 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
{ return current; } { return current; }
/** /**
* @return TODO * @return A reference to the value at @c --current
* *
* @doctodo * This requires that @c --current is dereferenceable.
*
* @warning This implementation requires that for an iterator of the
* underlying iterator type, @c x, a reference obtained by
* @c *x remains valid after @c x has been modified or
* destroyed. This is a bug: http://gcc.gnu.org/PR51823
*/ */
reference reference
operator*() const operator*() const
@ -161,18 +166,18 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
} }
/** /**
* @return TODO * @return A pointer to the value at @c --current
* *
* @doctodo * This requires that @c --current is dereferenceable.
*/ */
pointer pointer
operator->() const operator->() const
{ return &(operator*()); } { return &(operator*()); }
/** /**
* @return TODO * @return @c *this
* *
* @doctodo * Decrements the underlying iterator.
*/ */
reverse_iterator& reverse_iterator&
operator++() operator++()
@ -182,9 +187,9 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
} }
/** /**
* @return TODO * @return The original value of @c *this
* *
* @doctodo * Decrements the underlying iterator.
*/ */
reverse_iterator reverse_iterator
operator++(int) operator++(int)
@ -195,9 +200,9 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
} }
/** /**
* @return TODO * @return @c *this
* *
* @doctodo * Increments the underlying iterator.
*/ */
reverse_iterator& reverse_iterator&
operator--() operator--()
@ -207,9 +212,9 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
} }
/** /**
* @return TODO * @return A reverse_iterator with the previous value of @c *this
* *
* @doctodo * Increments the underlying iterator.
*/ */
reverse_iterator reverse_iterator
operator--(int) operator--(int)
@ -220,18 +225,19 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
} }
/** /**
* @return TODO * @return A reverse_iterator that refers to @c current - @a __n
* *
* @doctodo * The underlying iterator must be a Random Access Iterator.
*/ */
reverse_iterator reverse_iterator
operator+(difference_type __n) const operator+(difference_type __n) const
{ return reverse_iterator(current - __n); } { return reverse_iterator(current - __n); }
/** /**
* @return TODO * @return *this
* *
* @doctodo * Moves the underlying iterator backwards @a __n steps.
* The underlying iterator must be a Random Access Iterator.
*/ */
reverse_iterator& reverse_iterator&
operator+=(difference_type __n) operator+=(difference_type __n)
@ -241,18 +247,19 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
} }
/** /**
* @return TODO * @return A reverse_iterator that refers to @c current - @a __n
* *
* @doctodo * The underlying iterator must be a Random Access Iterator.
*/ */
reverse_iterator reverse_iterator
operator-(difference_type __n) const operator-(difference_type __n) const
{ return reverse_iterator(current + __n); } { return reverse_iterator(current + __n); }
/** /**
* @return TODO * @return *this
* *
* @doctodo * Moves the underlying iterator forwards @a __n steps.
* The underlying iterator must be a Random Access Iterator.
*/ */
reverse_iterator& reverse_iterator&
operator-=(difference_type __n) operator-=(difference_type __n)
@ -262,9 +269,9 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
} }
/** /**
* @return TODO * @return The value at @c current - @a __n - 1
* *
* @doctodo * The underlying iterator must be a Random Access Iterator.
*/ */
reference reference
operator[](difference_type __n) const operator[](difference_type __n) const