Documentation fixes:

- core.hpp: hide non-public macros
- default_delete.hpp: Hide detail code
- unique_ptr.hpp: Likewise
- utility_core.hpp: Document move_if_not_lvalue_reference
This commit is contained in:
Ion Gaztañaga
2015-09-13 21:50:34 +02:00
parent af0911bf0f
commit bd9532a6a4
4 changed files with 15 additions and 1 deletions

View File

@@ -27,6 +27,8 @@
#include <boost/move/detail/config_begin.hpp>
#include <boost/move/detail/workaround.hpp>
// @cond
//boost_move_no_copy_constructor_or_assign typedef
//used to detect noncopyable types for other Boost libraries.
#if defined(BOOST_NO_CXX11_DELETED_FUNCTIONS) || defined(BOOST_NO_CXX11_RVALUE_REFERENCES)
@@ -49,6 +51,8 @@
//
#endif //BOOST_NO_CXX11_DELETED_FUNCTIONS
// @endcond
#if defined(BOOST_NO_CXX11_RVALUE_REFERENCES) && !defined(BOOST_MOVE_DOXYGEN_INVOKED)
#include <boost/move/detail/type_traits.hpp>

View File

@@ -31,6 +31,7 @@
//! Describes the default deleter (destruction policy) of <tt>unique_ptr</tt>: <tt>default_delete</tt>.
namespace boost{
// @cond
namespace move_upd {
namespace bmupmu = ::boost::move_upmu;
@@ -96,6 +97,7 @@ typedef int bool_conversion::* explicit_bool_arg;
#endif
} //namespace move_upd {
// @endcond
namespace movelib {
@@ -123,7 +125,11 @@ struct default_delete
#endif
#if defined(BOOST_MOVE_DOXYGEN_INVOKED)
//! Trivial copy constructor
//!
default_delete(const default_delete&) BOOST_NOEXCEPT = default;
//! Trivial assignment
//!
default_delete &operator=(const default_delete&) BOOST_NOEXCEPT = default;
#else
typedef typename bmupmu::remove_extent<T>::type element_type;

View File

@@ -38,7 +38,7 @@
//! specially in C++03 compilers:
//! - <tt>operator < </tt> uses pointer <tt>operator < </tt>instead of <tt>std::less<common_type></tt>.
//! This avoids dependencies on <tt>std::common_type</tt> and <tt>std::less</tt>
//! (<tt><type_traits>/<functional></tt> headers. In C++03 this avoid pulling Boost.Typeof and other
//! (<tt><type_traits>/<functional></tt> headers). In C++03 this avoid pulling Boost.Typeof and other
//! cascading dependencies. As in all Boost platforms <tt>operator <</tt> on raw pointers and
//! other smart pointers provides strict weak ordering in practice this should not be a problem for users.
//! - assignable from literal 0 for compilers without nullptr
@@ -46,6 +46,7 @@
//! cv-less T and cv-less U are the same type and T is more CV qualified than U.
namespace boost{
// @cond
namespace move_upd {
////////////////////////////////////////////
@@ -301,6 +302,7 @@ struct enable_up_moveconv_constr
{};
} //namespace move_upd {
// @endcond
namespace movelib {

View File

@@ -265,6 +265,8 @@
#if defined(BOOST_MOVE_DOXYGEN_INVOKED)
//! <b>Effects</b>: Calls `boost::move` if `input_reference` is not a lvalue reference.
//! Otherwise returns the reference
template <class T> output_reference move_if_not_lvalue_reference(input_reference) noexcept;
#elif defined(BOOST_MOVE_OLD_RVALUE_REF_BINDING_RULES)