Author: tabish
Date: Mon Jul 20 14:41:39 2009
New Revision: 795863
URL: http://svn.apache.org/viewvc?rev=795863&view=rev
Log:
Updated API documentation.
Modified:
activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/ThreadFactory.h
Modified:
activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/ThreadFactory.h
URL:
http://svn.apache.org/viewvc/activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/ThreadFactory.h?rev=795863&r1=795862&r2=795863&view=diff
==============================================================================
---
activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/ThreadFactory.h
(original)
+++
activemq/activemq-cpp/trunk/activemq-cpp/src/main/decaf/util/concurrent/ThreadFactory.h
Mon Jul 20 14:41:39 2009
@@ -51,11 +51,15 @@
/**
* Constructs a new Thread. Implementations may also initialize
priority, name,
- * daemon status, ThreadGroup, etc.
+ * daemon status, ThreadGroup, etc. The pointer passed is still owned
by the caller
+ * and is not deleted by the Thread object. The caller owns the
returned Thread
+ * object and must delete it when finished.
*
- * @param r - a runnable to be executed by new thread instance
+ * @param r
+ * A pointer to a Runnable instance to be executed by new Thread
instance returned.
*
- * @returns constructed thread, or null if the request to create a
thread is rejected
+ * @returns constructed thread, or NULL if the request to create a
thread is rejected
+ * the caller owns the returned pointer.
*/
virtual Thread* newThread( Runnable* r ) = 0;
