boostorg/intrusive
1
0
Fork 1
mirror of https://github.com/boostorg/intrusive.git synced 2025-08-03 14:34:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen documentation fixes

Browse Source 
[SVN r76176]
This commit is contained in:
Ion Gaztañaga
2011-12-26 16:37:16 +00:00
parent b53862dabb
commit e94606c063
3 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
include/boost/intrusive/circular_slist_algorithms.hpp
View File

@@ -74,9 +74,9 @@ class circular_slist_algorithms
//! //!
//! <b>Effects</b>: Returns true is "this_node" is the only node of a circular list: //! <b>Effects</b>: Returns true is "this_node" is the only node of a circular list:
//! or it's a not inserted node: //! 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. //! <b>Throws</b>: Nothing.
static bool unique(const_node_ptr this_node); static bool unique(const_node_ptr this_node);

4
include/boost/intrusive/linear_slist_algorithms.hpp
View File

@@ -62,7 +62,7 @@ class linear_slist_algorithms
//! <b>Effects</b>: Constructs an non-used list element, putting the next //! <b>Effects</b>: Constructs an non-used list element, putting the next
//! pointer to null: //! pointer to null:
//! <tt>NodeTraits::get_next(this_node) == node_ptr() //! <tt>NodeTraits::get_next(this_node) == node_ptr()</tt>
//! //!
//! <b>Complexity</b>: Constant //! <b>Complexity</b>: Constant
//! //!
@@ -73,7 +73,7 @@ class linear_slist_algorithms
//! //!
//! <b>Effects</b>: Returns true is "this_node" is the only node of a circular list: //! <b>Effects</b>: Returns true is "this_node" is the only node of a circular list:
//! or it's a not inserted node: //! 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
//! //!

32
include/boost/intrusive/pointer_traits.hpp
View File

@@ -38,6 +38,10 @@ template <typename Ptr>
struct pointer_traits struct pointer_traits
{ {
#ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED #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 //!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 //!template instantiation of the form SomePointer<T, Args>, where Args is zero or
//!more type arguments ; otherwise , the specialization is ill-formed. //!more type arguments ; otherwise , the specialization is ill-formed.
@@ -47,10 +51,6 @@ struct pointer_traits
//!std::ptrdiff_t. //!std::ptrdiff_t.
typedef unspecified_type difference_type; 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 //!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 //!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. //!more type arguments ; otherwise, the instantiation of rebind is ill-formed.
@@ -86,10 +86,10 @@ struct pointer_traits
#endif #endif
#endif //#if !defined(BOOST_NO_TEMPLATE_ALIASES) #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 &. //! 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)); //! Non-standard extension: If such function does not exist, returns pointer(addressof(r));
static pointer pointer_to(reference r) static pointer pointer_to(reference r)
{ {
@@ -102,9 +102,9 @@ struct pointer_traits
return pointer_traits::priv_pointer_to(flag, r); return pointer_traits::priv_pointer_to(flag, r);
} }
//!<b>Remark</b>: Non-standard extension. //! <b>Remark</b>: Non-standard extension.
// //!
//!<b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::static_cast_from(r). //! <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)) //! If such function does not exist, returns pointer_to(static_cast<element_type&>(*uptr))
template<class UPtr> template<class UPtr>
static pointer static_cast_from(const UPtr &uptr) static pointer static_cast_from(const UPtr &uptr)
@@ -116,9 +116,9 @@ struct pointer_traits
return pointer_traits::priv_static_cast_from(flag, uptr); return pointer_traits::priv_static_cast_from(flag, uptr);
} }
//!<b>Remark</b>: Non-standard extension. //! <b>Remark</b>: Non-standard extension.
// //!
//!<b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::const_cast_from(r). //! <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)) //! If such function does not exist, returns pointer_to(const_cast<element_type&>(*uptr))
template<class UPtr> template<class UPtr>
static pointer const_cast_from(const UPtr &uptr) static pointer const_cast_from(const UPtr &uptr)
@@ -130,9 +130,9 @@ struct pointer_traits
return pointer_traits::priv_const_cast_from(flag, uptr); return pointer_traits::priv_const_cast_from(flag, uptr);
} }
//!<b>Remark</b>: Non-standard extension. //! <b>Remark</b>: Non-standard extension.
// //!
//!<b>Returns</b>: A dereferenceable pointer to r obtained by calling Ptr::dynamic_cast_from(r). //! <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)) //! If such function does not exist, returns pointer_to(*dynamic_cast<element_type*>(&*uptr))
template<class UPtr> template<class UPtr>
static pointer dynamic_cast_from(const UPtr &uptr) static pointer dynamic_cast_from(const UPtr &uptr)