diff options
| author | Steve Huston <shuston@riverace.com> | 2005-05-23 16:28:09 +0000 |
|---|---|---|
| committer | Steve Huston <shuston@riverace.com> | 2005-05-23 16:28:09 +0000 |
| commit | 4eeeea501494df9261c59786e45483d4fed92569 (patch) | |
| tree | 87cc4ea228f907ec9f98886214dd42f77a721b4b | |
| parent | bcfe6e9e72c70e19bd429d88372a408839d34a7d (diff) | |
| download | ATCD-4eeeea501494df9261c59786e45483d4fed92569.tar.gz | |
ChangeLogTag:Mon May 23 12:26:19 2005 Steve Huston <shuston@riverace.com>
| -rw-r--r-- | ChangeLog | 4 | ||||
| -rw-r--r-- | ace/Thread.h | 32 |
2 files changed, 21 insertions, 15 deletions
diff --git a/ChangeLog b/ChangeLog index a0fc112db3b..d49c1f23c84 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +Mon May 23 12:26:19 2005 Steve Huston <shuston@riverace.com> + + * ace/Thread.h: Doxygen-ized the join() comments. + Mon May 23 13:18:12 UTC 2005 Johnny Willemsen <jwillemsen@remedy.nl> * ace/Lib_Find.cpp: diff --git a/ace/Thread.h b/ace/Thread.h index 911f731d92c..05a81548d97 100644 --- a/ace/Thread.h +++ b/ace/Thread.h @@ -141,21 +141,23 @@ public: ACE_hthread_t thread_handles[] = 0, ACE_Thread_Adapter *thread_adapter = 0); - /// Wait for one or more threads to exit and reap their exit status. - /// thr_join() returns successfully when the target thread terminates. - /// - /// If a thr_join() call returns successfully with a non-null - /// status argument, the value passed to thr_exit(3T) by the - /// terminating thread will be placed in the location referenced - /// by status. - /// - /// If the target thread ID is 0, thr_join() waits for any - /// undetached thread in the process to terminate on platforms that - /// support this capability (namely Solaris). - /// - /// If departed is not 0, it points to a location that is set - /// to the ID of the terminated thread if thr_join() returns - /// successfully. + /** + * Wait for one or more threads to exit and reap their exit status. + * thr_join() returns successfully when the target thread terminates. + * + * @param thread_id is the ACE_thread_t ID of the thread to wait for. + * If @a thread_id is 0, join() waits for any + * undetached thread in the process to terminate + * on platforms that support this capability + * (for example, Solaris). + * @param departed points to a location that is set to the ID of the + * terminated thread if join() returns successfully. + * If @a departed is 0, it is ignored. + * @param status Points to the location that receives the joined + * thread's exit value. If @a status is 0, it is ignored. + * + * @retval 0 for success; -1 (with errno set) for failure. + */ static int join (ACE_thread_t thread_id, ACE_thread_t *departed, ACE_THR_FUNC_RETURN *status); |