[Boost-commit] svn:boost r57380 - trunk/libs/thread/doc

Subject: [Boost-commit] svn:boost r57380 - trunk/libs/thread/doc
From: anthony_at_[hidden]
Date: 2009-11-04 16:38:46

Author: anthonyw
Date: 2009-11-04 16:38:45 EST (Wed, 04 Nov 2009)
New Revision: 57380
URL: http://svn.boost.org/trac/boost/changeset/57380

Log:
Update docs for at_thread_exit
Text files modified: 
   trunk/libs/thread/doc/thread_ref.qbk |     7 +++++++                                 
   1 files changed, 7 insertions(+), 0 deletions(-)

Modified: trunk/libs/thread/doc/thread_ref.qbk
==============================================================================
--- trunk/libs/thread/doc/thread_ref.qbk	(original)
+++ trunk/libs/thread/doc/thread_ref.qbk	2009-11-04 16:38:45 EST (Wed, 04 Nov 2009)
@@ -916,6 +916,13 @@
 [[Throws:] [`std::bad_alloc` if memory cannot be allocated for the copy of the function, __thread_resource_error__ if any other
 error occurs within the thread library. Any exception thrown whilst copying `func` into internal storage.]]
 
+[[Note:] [This function is *not* called if the thread was terminated
+forcefully using platform-specific APIs, or if the thread is
+terminated due to a call to `exit()`, `abort()` or
+`std::terminate()`. In particular, returning from `main()` is
+equivalent to call to `exit()`, so will not call any functions
+registered with `at_thread_exit()`]]
+
 ]
 
 [endsect]