|
|
Boost-Commit : |
From: anthony_at_[hidden]
Date: 2008-07-25 17:12:30
Author: anthonyw
Date: 2008-07-25 17:12:29 EDT (Fri, 25 Jul 2008)
New Revision: 47810
URL: http://svn.boost.org/trac/boost/changeset/47810
Log:
Fix for issue #2105: specify which header to include for each class or function
Text files modified:
trunk/libs/thread/doc/condition_variables.qbk | 6 ++++++
trunk/libs/thread/doc/mutex_concepts.qbk | 10 ++++++++++
trunk/libs/thread/doc/mutexes.qbk | 12 ++++++++++++
trunk/libs/thread/doc/once.qbk | 4 ++++
trunk/libs/thread/doc/overview.qbk | 8 ++++++++
trunk/libs/thread/doc/shared_mutex_ref.qbk | 2 ++
trunk/libs/thread/doc/thread_ref.qbk | 26 ++++++++++++++++++++++++++
trunk/libs/thread/doc/time.qbk | 4 ++++
trunk/libs/thread/doc/tss.qbk | 2 ++
9 files changed, 74 insertions(+), 0 deletions(-)
Modified: trunk/libs/thread/doc/condition_variables.qbk
==============================================================================
--- trunk/libs/thread/doc/condition_variables.qbk (original)
+++ trunk/libs/thread/doc/condition_variables.qbk 2008-07-25 17:12:29 EDT (Fri, 25 Jul 2008)
@@ -74,6 +74,8 @@
[section:condition_variable Class `condition_variable`]
+ #include <boost/thread/condition_variable.hpp>
+
namespace boost
{
class condition_variable
@@ -294,6 +296,8 @@
[section:condition_variable_any Class `condition_variable_any`]
+ #include <boost/thread/condition_variable.hpp>
+
namespace boost
{
class condition_variable_any
@@ -498,6 +502,8 @@
[section:condition Typedef `condition`]
+ #include <boost/thread/condition.hpp>
+
typedef condition_variable_any condition;
The typedef `condition` is provided for backwards compatibility with previous boost releases.
Modified: trunk/libs/thread/doc/mutex_concepts.qbk
==============================================================================
--- trunk/libs/thread/doc/mutex_concepts.qbk (original)
+++ trunk/libs/thread/doc/mutex_concepts.qbk 2008-07-25 17:12:29 EDT (Fri, 25 Jul 2008)
@@ -312,6 +312,8 @@
[section:lock_guard Class template `lock_guard`]
+ #include <boost/thread/locks.hpp>
+
template<typename Lockable>
class lock_guard
{
@@ -376,6 +378,8 @@
[section:unique_lock Class template `unique_lock`]
+ #include <boost/thread/locks.hpp>
+
template<typename Lockable>
class unique_lock
{
@@ -617,6 +621,8 @@
[section:shared_lock Class template `shared_lock`]
+ #include <boost/thread/locks.hpp>
+
template<typename Lockable>
class shared_lock
{
@@ -850,6 +856,8 @@
[section:upgrade_lock Class template `upgrade_lock`]
+ #include <boost/thread/locks.hpp>
+
template<typename Lockable>
class upgrade_lock
{
@@ -897,6 +905,8 @@
[section:upgrade_to_unique_lock Class template `upgrade_to_unique_lock`]
+ #include <boost/thread/locks.hpp>
+
template <class Lockable>
class upgrade_to_unique_lock
{
Modified: trunk/libs/thread/doc/mutexes.qbk
==============================================================================
--- trunk/libs/thread/doc/mutexes.qbk (original)
+++ trunk/libs/thread/doc/mutexes.qbk 2008-07-25 17:12:29 EDT (Fri, 25 Jul 2008)
@@ -9,6 +9,8 @@
[section:mutex Class `mutex`]
+ #include <boost/thread/mutex.hpp>
+
class mutex:
boost::noncopyable
{
@@ -51,6 +53,8 @@
[section:try_mutex Typedef `try_mutex`]
+ #include <boost/thread/mutex.hpp>
+
typedef mutex try_mutex;
__try_mutex__ is a `typedef` to __mutex__, provided for backwards compatibility with previous releases of boost.
@@ -59,6 +63,8 @@
[section:timed_mutex Class `timed_mutex`]
+ #include <boost/thread/mutex.hpp>
+
class timed_mutex:
boost::noncopyable
{
@@ -106,6 +112,8 @@
[section:recursive_mutex Class `recursive_mutex`]
+ #include <boost/thread/recursive_mutex.hpp>
+
class recursive_mutex:
boost::noncopyable
{
@@ -150,6 +158,8 @@
[section:recursive_try_mutex Typedef `recursive_try_mutex`]
+ #include <boost/thread/recursive_mutex.hpp>
+
typedef recursive_mutex recursive_try_mutex;
__recursive_try_mutex__ is a `typedef` to __recursive_mutex__, provided for backwards compatibility with previous releases of boost.
@@ -158,6 +168,8 @@
[section:recursive_timed_mutex Class `recursive_timed_mutex`]
+ #include <boost/thread/recursive_mutex.hpp>
+
class recursive_timed_mutex:
boost::noncopyable
{
Modified: trunk/libs/thread/doc/once.qbk
==============================================================================
--- trunk/libs/thread/doc/once.qbk (original)
+++ trunk/libs/thread/doc/once.qbk 2008-07-25 17:12:29 EDT (Fri, 25 Jul 2008)
@@ -11,6 +11,8 @@
[section:once_flag Typedef `once_flag`]
+ #include <boost/thread/once.hpp>
+
typedef platform-specific-type once_flag;
#define BOOST_ONCE_INIT platform-specific-initializer
@@ -22,6 +24,8 @@
[section:call_once Non-member function `call_once`]
+ #include <boost/thread/once.hpp>
+
template<typename Callable>
void call_once(once_flag& flag,Callable func);
Modified: trunk/libs/thread/doc/overview.qbk
==============================================================================
--- trunk/libs/thread/doc/overview.qbk (original)
+++ trunk/libs/thread/doc/overview.qbk 2008-07-25 17:12:29 EDT (Fri, 25 Jul 2008)
@@ -19,4 +19,12 @@
[@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2139.html N2139], and
[@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2006/n2094.html N2094]
+In order to use the classes and functions described here, you can
+either include the specific headers specified by the descriptions of
+each class or function, or include the master thread library header:
+
+ #include <boost/thread.hpp>
+
+which includes all the other headers in turn.
+
[endsect]
Modified: trunk/libs/thread/doc/shared_mutex_ref.qbk
==============================================================================
--- trunk/libs/thread/doc/shared_mutex_ref.qbk (original)
+++ trunk/libs/thread/doc/shared_mutex_ref.qbk 2008-07-25 17:12:29 EDT (Fri, 25 Jul 2008)
@@ -7,6 +7,8 @@
[section:shared_mutex Class `shared_mutex`]
+ #include <boost/thread/shared_mutex.hpp>
+
class shared_mutex
{
public:
Modified: trunk/libs/thread/doc/thread_ref.qbk
==============================================================================
--- trunk/libs/thread/doc/thread_ref.qbk (original)
+++ trunk/libs/thread/doc/thread_ref.qbk 2008-07-25 17:12:29 EDT (Fri, 25 Jul 2008)
@@ -165,6 +165,8 @@
[section:thread Class `thread`]
+ #include <boost/thread/thread.hpp>
+
class thread
{
public:
@@ -480,6 +482,8 @@
[section:non_member_swap Non-member function `swap()`]
+ #include <boost/thread/thread.hpp>
+
void swap(thread& lhs,thread& rhs);
[variablelist
@@ -493,6 +497,8 @@
[section:id Class `boost::thread::id`]
+ #include <boost/thread/thread.hpp>
+
class thread::id
{
public:
@@ -641,6 +647,8 @@
[section:get_id Non-member function `get_id()`]
+ #include <boost/thread/thread.hpp>
+
namespace this_thread
{
thread::id get_id();
@@ -658,6 +666,8 @@
[section:interruption_point Non-member function `interruption_point()`]
+ #include <boost/thread/thread.hpp>
+
namespace this_thread
{
void interruption_point();
@@ -675,6 +685,8 @@
[section:interruption_requested Non-member function `interruption_requested()`]
+ #include <boost/thread/thread.hpp>
+
namespace this_thread
{
bool interruption_requested();
@@ -692,6 +704,8 @@
[section:interruption_enabled Non-member function `interruption_enabled()`]
+ #include <boost/thread/thread.hpp>
+
namespace this_thread
{
bool interruption_enabled();
@@ -709,6 +723,8 @@
[section:sleep Non-member function `sleep()`]
+ #include <boost/thread/thread.hpp>
+
namespace this_thread
{
template<typename TimeDuration>
@@ -729,6 +745,8 @@
[section:yield Non-member function `yield()`]
+ #include <boost/thread/thread.hpp>
+
namespace this_thread
{
void yield();
@@ -746,6 +764,8 @@
[section:disable_interruption Class `disable_interruption`]
+ #include <boost/thread/thread.hpp>
+
namespace this_thread
{
class disable_interruption
@@ -797,6 +817,8 @@
[section:restore_interruption Class `restore_interruption`]
+ #include <boost/thread/thread.hpp>
+
namespace this_thread
{
class restore_interruption
@@ -851,6 +873,8 @@
[section:atthreadexit Non-member function template `at_thread_exit()`]
+ #include <boost/thread/thread.hpp>
+
template<typename Callable>
void at_thread_exit(Callable func);
@@ -871,6 +895,8 @@
[section:threadgroup Class `thread_group`]
+ #include <boost/thread/thread.hpp>
+
class thread_group:
private noncopyable
{
Modified: trunk/libs/thread/doc/time.qbk
==============================================================================
--- trunk/libs/thread/doc/time.qbk (original)
+++ trunk/libs/thread/doc/time.qbk 2008-07-25 17:12:29 EDT (Fri, 25 Jul 2008)
@@ -47,6 +47,8 @@
[section:system_time Typedef `system_time`]
+ #include <boost/thread/thread_time.hpp>
+
typedef boost::posix_time::ptime system_time;
See the documentation for [link date_time.posix_time.ptime_class `boost::posix_time::ptime`] in the Boost.Date_Time library.
@@ -55,6 +57,8 @@
[section:get_system_time Non-member function `get_system_time()`]
+ #include <boost/thread/thread_time.hpp>
+
system_time get_system_time();
[variablelist
Modified: trunk/libs/thread/doc/tss.qbk
==============================================================================
--- trunk/libs/thread/doc/tss.qbk (original)
+++ trunk/libs/thread/doc/tss.qbk 2008-07-25 17:12:29 EDT (Fri, 25 Jul 2008)
@@ -44,6 +44,8 @@
[section:thread_specific_ptr Class `thread_specific_ptr`]
+ #include <boost/thread/tss.hpp>
+
template <typename T>
class thread_specific_ptr
{
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk