Subject: [Boost-commit] svn:boost r76176 - trunk/boost/intrusive
From: igaztanaga_at_[hidden]
Date: 2011-12-26 11:37:17
Author: igaztanaga
Date: 2011-12-26 11:37:16 EST (Mon, 26 Dec 2011)
New Revision: 76176
URL: http://svn.boost.org/trac/boost/changeset/76176
Log:
Doxygen documentation fixes
Text files modified:
trunk/boost/intrusive/circular_slist_algorithms.hpp | 4 ++--
trunk/boost/intrusive/linear_slist_algorithms.hpp | 4 ++--
trunk/boost/intrusive/pointer_traits.hpp | 32 ++++++++++++++++----------------
3 files changed, 20 insertions(+), 20 deletions(-)
Modified: trunk/boost/intrusive/circular_slist_algorithms.hpp
==============================================================================
--- trunk/boost/intrusive/circular_slist_algorithms.hpp (original)
+++ trunk/boost/intrusive/circular_slist_algorithms.hpp 2011-12-26 11:37:16 EST (Mon, 26 Dec 2011)
@@ -74,9 +74,9 @@
//!
//! <b>Effects</b>: Returns true is "this_node" is the only node of a circular list:
//! or it's a not inserted node:
- //! <tt>return !NodeTraits::get_next(this_node) || NodeTraits::get_next(this_node) == this_node</tt>
+ //! <tt>return false == NodeTraits::get_next(this_node) || NodeTraits::get_next(this_node) == this_node</tt>
//!
- //! <b>Complexity</b>: Constant
+ //! <b>Complexity</b>: Constant
//!
//! <b>Throws</b>: Nothing.
static bool unique(const_node_ptr this_node);
Modified: trunk/boost/intrusive/linear_slist_algorithms.hpp
==============================================================================
--- trunk/boost/intrusive/linear_slist_algorithms.hpp (original)
+++ trunk/boost/intrusive/linear_slist_algorithms.hpp 2011-12-26 11:37:16 EST (Mon, 26 Dec 2011)
@@ -62,7 +62,7 @@
//! <b>Effects</b>: Constructs an non-used list element, putting the next
//! pointer to null:
- //! <tt>NodeTraits::get_next(this_node) == node_ptr()
+ //! <tt>NodeTraits::get_next(this_node) == node_ptr()</tt>
//!
//! <b>Complexity</b>: Constant
//!
@@ -73,7 +73,7 @@
//!
//! <b>Effects</b>: Returns true is "this_node" is the only node of a circular list:
//! or it's a not inserted node:
- //! <tt>return !NodeTraits::get_next(this_node) || NodeTraits::get_next(this_node) == this_node</tt>
+ //! <tt>return false == NodeTraits::get_next(this_node) || NodeTraits::get_next(this_node) == this_node</tt>
//!
//! <b>Complexity</b>: Constant
//!
Modified: trunk/boost/intrusive/pointer_traits.hpp
==============================================================================
--- trunk/boost/intrusive/pointer_traits.hpp (original)
+++ trunk/boost/intrusive/pointer_traits.hpp 2011-12-26 11:37:16 EST (Mon, 26 Dec 2011)
@@ -38,6 +38,10 @@
struct pointer_traits
{
#ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
+ //!The pointer type
+ //!queried by this pointer_traits instantiation
+ typedef Ptr pointer;
+
//!Ptr::element_type if such a type exists; otherwise, T if Ptr is a class
//!template instantiation of the form SomePointer<T, Args>, where Args is zero or
//!more type arguments ; otherwise , the specialization is ill-formed.
@@ -47,10 +51,6 @@
//!std::ptrdiff_t.
typedef unspecified_type difference_type;
- //!Ptr::difference_type if such a type exists; otherwise,
- //!std::ptrdiff_t.
- typedef unspecified_type difference_type;
-
//!Ptr::rebind<U> if such a type exists; otherwise, SomePointer<U, Args> if Ptr is
//!a class template instantiation of the form SomePointer<T, Args>, where Args is zero or
//!more type arguments ; otherwise, the instantiation of rebind is ill-formed.
@@ -86,10 +86,10 @@
#endif
#endif //#if !defined(BOOST_NO_TEMPLATE_ALIASES)
- //!<b>Remark</b>: If element_type is (possibly cv-qualified) void, r type is unspecified; otherwise,
+ //! <b>Remark</b>: If element_type is (possibly cv-qualified) void, r type is unspecified; otherwise,
//! it is element_type &.
- //
- //!<b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::pointer_to(r).
+ //!
+ //! <b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::pointer_to(r).
//! Non-standard extension: If such function does not exist, returns pointer(addressof(r));
static pointer pointer_to(reference r)
{
@@ -102,9 +102,9 @@
return pointer_traits::priv_pointer_to(flag, r);
}
- //!<b>Remark</b>: Non-standard extension.
- //
- //!<b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::static_cast_from(r).
+ //! <b>Remark</b>: Non-standard extension.
+ //!
+ //! <b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::static_cast_from(r).
//! If such function does not exist, returns pointer_to(static_cast<element_type&>(*uptr))
template<class UPtr>
static pointer static_cast_from(const UPtr &uptr)
@@ -116,9 +116,9 @@
return pointer_traits::priv_static_cast_from(flag, uptr);
}
- //!<b>Remark</b>: Non-standard extension.
- //
- //!<b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::const_cast_from(r).
+ //! <b>Remark</b>: Non-standard extension.
+ //!
+ //! <b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::const_cast_from(r).
//! If such function does not exist, returns pointer_to(const_cast<element_type&>(*uptr))
template<class UPtr>
static pointer const_cast_from(const UPtr &uptr)
@@ -130,9 +130,9 @@
return pointer_traits::priv_const_cast_from(flag, uptr);
}
- //!<b>Remark</b>: Non-standard extension.
- //
- //!<b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::dynamic_cast_from(r).
+ //! <b>Remark</b>: Non-standard extension.
+ //!
+ //! <b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::dynamic_cast_from(r).
//! If such function does not exist, returns pointer_to(*dynamic_cast<element_type*>(&*uptr))
template<class UPtr>
static pointer dynamic_cast_from(const UPtr &uptr)