forked from boostorg/core
Documentation updates.
This commit is contained in:
@ -9,13 +9,13 @@
|
|||||||
|
|
||||||
[section:addressof addressof]
|
[section:addressof addressof]
|
||||||
|
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
|
|
||||||
* Brad King
|
* Brad King
|
||||||
* Douglas Gregor
|
* Douglas Gregor
|
||||||
* Peter Dimov
|
* Peter Dimov
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[section Header <boost/core/addressof.hpp>]
|
[section Header <boost/core/addressof.hpp>]
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
[section:checked_delete checked_delete]
|
[section:checked_delete checked_delete]
|
||||||
|
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
|
|
||||||
* Beman Dawes
|
* Beman Dawes
|
||||||
* Dave Abrahams
|
* Dave Abrahams
|
||||||
@ -8,7 +8,7 @@
|
|||||||
* Rainer Deyke
|
* Rainer Deyke
|
||||||
* John Maddock
|
* John Maddock
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[section Overview]
|
[section Overview]
|
||||||
|
|
||||||
|
38
doc/core.qbk
38
doc/core.qbk
@ -8,7 +8,7 @@
|
|||||||
]
|
]
|
||||||
|
|
||||||
[library Boost.Core
|
[library Boost.Core
|
||||||
[quickbook 1.5]
|
[quickbook 1.6]
|
||||||
[id core]
|
[id core]
|
||||||
[copyright 2014 Peter Dimov]
|
[copyright 2014 Peter Dimov]
|
||||||
[copyright 2014 Glen Fernandes]
|
[copyright 2014 Glen Fernandes]
|
||||||
@ -20,6 +20,12 @@
|
|||||||
]
|
]
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[template simplesect[title]
|
||||||
|
[block '''<simplesect><title>'''[title]'''</title>''']]
|
||||||
|
|
||||||
|
[template endsimplesect[]
|
||||||
|
[block '''</simplesect>''']]
|
||||||
|
|
||||||
[section Introduction]
|
[section Introduction]
|
||||||
|
|
||||||
The Boost.Core library is a collection of core utilities. The
|
The Boost.Core library is a collection of core utilities. The
|
||||||
@ -32,18 +38,18 @@ criteria for inclusion is that the utility component be:
|
|||||||
|
|
||||||
[endsect]
|
[endsect]
|
||||||
|
|
||||||
[include:core addressof.qbk]
|
[include addressof.qbk]
|
||||||
[include:core checked_delete.qbk]
|
[include checked_delete.qbk]
|
||||||
[include:core demangle.qbk]
|
[include demangle.qbk]
|
||||||
[include:core enable_if.qbk]
|
[include enable_if.qbk]
|
||||||
[include:core explicit_operator_bool.qbk]
|
[include explicit_operator_bool.qbk]
|
||||||
[include:core ignore_unused.qbk]
|
[include ignore_unused.qbk]
|
||||||
[include:core is_same.qbk]
|
[include is_same.qbk]
|
||||||
[include:core lightweight_test.qbk]
|
[include lightweight_test.qbk]
|
||||||
[include:core no_exceptions_support.qbk]
|
[include no_exceptions_support.qbk]
|
||||||
[include:core noncopyable.qbk]
|
[include noncopyable.qbk]
|
||||||
[include:core null_deleter.qbk]
|
[include null_deleter.qbk]
|
||||||
[include:core ref.qbk]
|
[include ref.qbk]
|
||||||
[include:core scoped_enum.qbk]
|
[include scoped_enum.qbk]
|
||||||
[include:core swap.qbk]
|
[include swap.qbk]
|
||||||
[include:core typeinfo.qbk]
|
[include typeinfo.qbk]
|
||||||
|
@ -9,12 +9,12 @@
|
|||||||
|
|
||||||
[section:demangle demangle]
|
[section:demangle demangle]
|
||||||
|
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
|
|
||||||
* Peter Dimov
|
* Peter Dimov
|
||||||
* Andrey Semashev
|
* Andrey Semashev
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[section Header <boost/core/demangle.hpp>]
|
[section Header <boost/core/demangle.hpp>]
|
||||||
|
|
||||||
|
@ -1,12 +1,12 @@
|
|||||||
[section:enable_if enable_if]
|
[section:enable_if enable_if]
|
||||||
|
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
|
|
||||||
* Jaakko J\u00E4rvi
|
* Jaakko J\u00E4rvi
|
||||||
* Jeremiah Willcock
|
* Jeremiah Willcock
|
||||||
* Andrew Lumsdaine
|
* Andrew Lumsdaine
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[section Introduction]
|
[section Introduction]
|
||||||
|
|
||||||
|
@ -7,13 +7,13 @@
|
|||||||
/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
/ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||||
/]
|
/]
|
||||||
|
|
||||||
[/==============]
|
[/=================]
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
[/==============]
|
[/=================]
|
||||||
|
|
||||||
* Andrey Semashev
|
* Andrey Semashev
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[/===============]
|
[/===============]
|
||||||
[section Overview]
|
[section Overview]
|
||||||
|
@ -9,11 +9,11 @@
|
|||||||
|
|
||||||
[section:ignore_unused ignore_unused]
|
[section:ignore_unused ignore_unused]
|
||||||
|
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
|
|
||||||
* Adam Wulkiewicz
|
* Adam Wulkiewicz
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[section Header <boost/core/ignore_unused.hpp>]
|
[section Header <boost/core/ignore_unused.hpp>]
|
||||||
|
|
||||||
|
@ -9,11 +9,11 @@
|
|||||||
|
|
||||||
[section:is_same is_same]
|
[section:is_same is_same]
|
||||||
|
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
|
|
||||||
* Peter Dimov
|
* Peter Dimov
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[section Header <boost/core/is_same.hpp>]
|
[section Header <boost/core/is_same.hpp>]
|
||||||
|
|
||||||
|
@ -11,12 +11,12 @@
|
|||||||
|
|
||||||
[section:lightweight_test lightweight_test]
|
[section:lightweight_test lightweight_test]
|
||||||
|
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
|
|
||||||
* Peter Dimov
|
* Peter Dimov
|
||||||
* Beman Dawes
|
* Beman Dawes
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[section Header <boost/core/lightweight_test.hpp>]
|
[section Header <boost/core/lightweight_test.hpp>]
|
||||||
|
|
||||||
|
@ -10,11 +10,11 @@
|
|||||||
|
|
||||||
[section:no_exceptions_support no_exceptions_support]
|
[section:no_exceptions_support no_exceptions_support]
|
||||||
|
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
|
|
||||||
* Pavel Vozenilek
|
* Pavel Vozenilek
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[section Header <boost/core/no_exceptions_support.hpp>]
|
[section Header <boost/core/no_exceptions_support.hpp>]
|
||||||
|
|
||||||
|
@ -10,11 +10,11 @@
|
|||||||
|
|
||||||
[section:noncopyable noncopyable]
|
[section:noncopyable noncopyable]
|
||||||
|
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
|
|
||||||
* Dave Abrahams
|
* Dave Abrahams
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[section Header <boost/core/noncopyable.hpp>]
|
[section Header <boost/core/noncopyable.hpp>]
|
||||||
|
|
||||||
|
@ -7,11 +7,11 @@
|
|||||||
|
|
||||||
[section:null_deleter null_deleter]
|
[section:null_deleter null_deleter]
|
||||||
|
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
|
|
||||||
* Andrey Semashev
|
* Andrey Semashev
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[section Header <boost/core/null_deleter.hpp>]
|
[section Header <boost/core/null_deleter.hpp>]
|
||||||
|
|
||||||
@ -20,12 +20,14 @@ which can be used as a deleter with smart pointers such as `unique_ptr` or `shar
|
|||||||
deleter doesn't do anything with the pointer provided upon deallocation, which makes it useful
|
deleter doesn't do anything with the pointer provided upon deallocation, which makes it useful
|
||||||
when the pointed object is deallocated elsewhere.
|
when the pointed object is deallocated elsewhere.
|
||||||
|
|
||||||
Example
|
[section Example]
|
||||||
|
``
|
||||||
std::shared_ptr< std::ostream > make_stream()
|
std::shared_ptr< std::ostream > make_stream()
|
||||||
{
|
{
|
||||||
return std::shared_ptr< std::ostream >(&std::cout, boost::null_deleter());
|
return std::shared_ptr< std::ostream >(&std::cout, boost::null_deleter());
|
||||||
}
|
}
|
||||||
|
``
|
||||||
|
[endsect]
|
||||||
|
|
||||||
[endsect]
|
[endsect]
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
[section:ref ref]
|
[section:ref ref]
|
||||||
|
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
|
|
||||||
* Jaakko J\u00E4rvi
|
* Jaakko J\u00E4rvi
|
||||||
* Peter Dimov
|
* Peter Dimov
|
||||||
@ -9,7 +9,7 @@
|
|||||||
* Frank Mori Hess
|
* Frank Mori Hess
|
||||||
* Ronald Garcia
|
* Ronald Garcia
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[section Introduction]
|
[section Introduction]
|
||||||
|
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
[quickbook 1.5]
|
||||||
|
|
||||||
[section:scoped_enum scoped_enum]
|
[section:scoped_enum scoped_enum]
|
||||||
|
|
||||||
[section Authors]
|
[section Authors]
|
||||||
|
@ -1,13 +1,13 @@
|
|||||||
[section:swap swap]
|
[section:swap swap]
|
||||||
|
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
|
|
||||||
* Niels Dekker
|
* Niels Dekker
|
||||||
* Joseph Gauterin
|
* Joseph Gauterin
|
||||||
* Steven Watanabe
|
* Steven Watanabe
|
||||||
* Eric Niebler
|
* Eric Niebler
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[section Header <boost/core/swap.hpp>]
|
[section Header <boost/core/swap.hpp>]
|
||||||
|
|
||||||
|
@ -9,11 +9,11 @@
|
|||||||
|
|
||||||
[section:typeinfo typeinfo]
|
[section:typeinfo typeinfo]
|
||||||
|
|
||||||
[section Authors]
|
[simplesect Authors]
|
||||||
|
|
||||||
* Peter Dimov
|
* Peter Dimov
|
||||||
|
|
||||||
[endsect]
|
[endsimplesect]
|
||||||
|
|
||||||
[section Header <boost/core/typeinfo.hpp>]
|
[section Header <boost/core/typeinfo.hpp>]
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user