@@ -25,17 +25,17 @@ #ifdef OF_HAVE_BLOCKS typedef id (^of_thread_block_t)(id object); #endif -/** - * \brief A class which provides portable threads. +/*! + * @brief A class which provides portable threads. * * To use it, you should create a new class derived from it and reimplement * main. * - * \warning Even though the OFCopying protocol is implemented, it does + * @warning Even though the OFCopying protocol is implemented, it does * not return an independent copy of the thread, but instead * retains it. This is so that the thread can be used as a key for a * dictionary, so context can be associated with a thread. */ @interface OFThread: OFObject @@ -62,157 +62,157 @@ #if defined(OF_HAVE_PROPERTIES) && defined(OF_HAVE_BLOCKS) @property (copy) of_thread_block_t block; #endif -/** - * \brief Creates a new thread. +/*! + * @brief Creates a new thread. * - * \return A new, autoreleased thread + * @return A new, autoreleased thread */ + (instancetype)thread; -/** - * \brief Creates a new thread with the specified object. +/*! + * @brief Creates a new thread with the specified object. * - * \param object An object which is passed for use in the main method or nil - * \return A new, autoreleased thread + * @param object An object which is passed for use in the main method or nil + * @return A new, autoreleased thread */ + (instancetype)threadWithObject: (id)object; #ifdef OF_HAVE_BLOCKS -/** - * \brief Creates a new thread with the specified block. +/*! + * @brief Creates a new thread with the specified block. * - * \param block A block which is executed by the thread - * \return A new, autoreleased thread + * @param block A block which is executed by the thread + * @return A new, autoreleased thread */ + (instancetype)threadWithBlock: (of_thread_block_t)block; #endif -/** - * \brief Sets the Thread Local Storage for the specified key. +/*! + * @brief Sets the Thread Local Storage for the specified key. * * The specified object is first retained and then the object stored before is * released. You can specify nil as object if you want the old object to be * released and don't want any new object for the TLS key. * - * \param key The Thread Local Storage key - * \param object The object the Thread Local Storage key will be set to + * @param key The Thread Local Storage key + * @param object The object the Thread Local Storage key will be set to */ + (void)setObject: (id)object forTLSKey: (OFTLSKey*)key; -/** - * \brief Returns the object for the specified Thread Local Storage key. +/*! + * @brief Returns the object for the specified Thread Local Storage key. * * The returned object is not retained and autoreleased for performance * reasons! * - * \param key The Thread Local Storage key + * @param key The Thread Local Storage key */ + (id)objectForTLSKey: (OFTLSKey*)key; -/** - * \brief Returns the current thread. +/*! + * @brief Returns the current thread. * - * \return The current thread + * @return The current thread */ + (OFThread*)currentThread; -/** - * \brief Returns the main thread. +/*! + * @brief Returns the main thread. * - * \return The main thread + * @return The main thread */ + (OFThread*)mainThread; -/** - * \brief Suspends execution of the current thread for the specified time +/*! + * @brief Suspends execution of the current thread for the specified time * interval. * - * \param seconds The number of seconds to sleep + * @param seconds The number of seconds to sleep */ + (void)sleepForTimeInterval: (double)seconds; -/** - * \brief Suspends execution of the current thread until the specified date. +/*! + * @brief Suspends execution of the current thread until the specified date. * - * \param date The date to wait for + * @param date The date to wait for */ + (void)sleepUntilDate: (OFDate*)date; -/** - * \brief Yields a processor voluntarily and moves the thread at the end of the +/*! + * @brief Yields a processor voluntarily and moves the thread at the end of the * queue for its priority. */ + (void)yield; -/** - * \brief Terminates the current thread, letting it return nil. +/*! + * @brief Terminates the current thread, letting it return nil. */ + (void)terminate; -/** - * \brief Terminates the current thread, letting it return the specified object. +/*! + * @brief Terminates the current thread, letting it return the specified object. * - * \param object The object which the terminated thread will return + * @param object The object which the terminated thread will return */ + (void)terminateWithObject: (id)object; + (void)OF_createMainThread; -/** - * \brief Initializes an already allocated thread with the specified object. +/*! + * @brief Initializes an already allocated thread with the specified object. * - * \param object An object which is passed for use in the main method or nil - * \return An initialized OFThread. + * @param object An object which is passed for use in the main method or nil + * @return An initialized OFThread. */ - initWithObject: (id)object; #ifdef OF_HAVE_BLOCKS -/** - * \brief Initializes an already allocated thread with the specified block. +/*! + * @brief Initializes an already allocated thread with the specified block. * - * \param block A block which is executed by the thread - * \return An initialized OFThread. + * @param block A block which is executed by the thread + * @return An initialized OFThread. */ - initWithBlock: (of_thread_block_t)block; #endif -/** - * \brief The main routine of the thread. You need to reimplement this! +/*! + * @brief The main routine of the thread. You need to reimplement this! * * It can access the object passed to the threadWithObject or initWithObject * method using the instance variable named object. * - * \return The object the join method should return when called for this thread + * @return The object the join method should return when called for this thread */ - (id)main; -/** - * \brief This routine is exectued when the thread's main method has finished +/*! + * @brief This routine is exectued when the thread's main method has finished * executing or terminate has been called. * - * \note Be sure to call [super handleTermination]! + * @note Be sure to call [super handleTermination]! */ - (void)handleTermination; -/** - * \brief Starts the thread. +/*! + * @brief Starts the thread. */ - (void)start; -/** - * \brief Joins a thread. +/*! + * @brief Joins a thread. * - * \return The object returned by the main method of the thread. + * @return The object returned by the main method of the thread. */ - (id)join; -/** - * \brief Returns the run loop for the thread. +/*! + * @brief Returns the run loop for the thread. * - * \return The run loop for the thread + * @return The run loop for the thread */ - (OFRunLoop*)runLoop; @end