@@ -22,11 +22,11 @@ # include #endif OF_ASSUME_NONNULL_BEGIN -/*! @file */ +/** @file */ @class OFSortedList OF_GENERIC(ObjectType); #ifdef OF_HAVE_THREADS @class OFMutex; @class OFCondition; @@ -36,27 +36,27 @@ #endif @class OFMutableDictionary OF_GENERIC(KeyType, ObjectType); @class OFTimer; @class OFDate; -/*! +/** * @brief A mode for an OFRunLoop. */ typedef OFConstantString *of_run_loop_mode_t; #ifdef __cplusplus extern "C" { #endif -/*! +/** * @brief The default mode for an OFRunLoop. */ extern const of_run_loop_mode_t of_run_loop_mode_default; #ifdef __cplusplus } #endif -/*! +/** * @class OFRunLoop OFRunLoop.h ObjFW/OFRunLoop.h * * @brief A class providing a run loop for the application and its processes. */ OF_SUBCLASSING_RESTRICTED @@ -75,42 +75,42 @@ @property (class, readonly, nullable, nonatomic) OFRunLoop *currentRunLoop; #endif @property OF_NULLABLE_PROPERTY (readonly, nonatomic) of_run_loop_mode_t currentMode; -/*! +/** * @brief Returns the run loop for the main thread. * * @return The run loop for the main thread */ + (nullable OFRunLoop *)mainRunLoop; -/*! +/** * @brief Returns the run loop for the current thread. * * @return The run loop for the current thread */ + (nullable OFRunLoop *)currentRunLoop; -/*! +/** * @brief Adds an OFTimer to the run loop. * * @param timer The timer to add */ - (void)addTimer: (OFTimer *)timer; -/*! +/** * @brief Adds an OFTimer to the run loop for the specified mode. * * @param timer The timer to add * @param mode The run loop mode in which to run the timer */ - (void)addTimer: (OFTimer *)timer forMode: (of_run_loop_mode_t)mode; #ifdef OF_AMIGAOS -/*! +/** * @brief Adds an Exec Signal to the run loop. * * If a signal is added multiple times, the specified methods will be performed * in the order added. * @@ -124,11 +124,11 @@ */ - (void)addExecSignal: (ULONG)signal target: (id)target selector: (SEL)selector; -/*! +/** * @brief Adds an Exec Signal to the run loop for the specified mode. * * If a signal is added multiple times, the specified methods will be performed * in the order added. * @@ -144,11 +144,11 @@ - (void)addExecSignal: (ULONG)signal forMode: (of_run_loop_mode_t)mode target: (id)target selector: (SEL)selector; -/*! +/** * @brief Removes the specified Exec Signal with the specified target and * selector. * * @param signal The signal to remove * @param target The target which was specified when adding the signal @@ -156,11 +156,11 @@ */ - (void)removeExecSignal: (ULONG)signal target: (id)target selector: (SEL)selector; -/*! +/** * @brief Removes the specified Exec Signal from the specified mode with the * specified target and selector. * * @param signal The signal to remove * @param mode The run loop mode to which the signal was added @@ -171,35 +171,35 @@ forMode: (of_run_loop_mode_t)mode target: (id)target selector: (SEL)selector; #endif -/*! +/** * @brief Starts the run loop. */ - (void)run; -/*! +/** * @brief Run the run loop until the specified deadline. * * @param deadline The date until which the run loop should run */ - (void)runUntilDate: (nullable OFDate *)deadline; -/*! +/** * @brief Run the run loop until an event or timer occurs or the specified * deadline is reached. * * @param mode The mode in which to run the run loop * @param deadline The date until which the run loop should run at the longest */ - (void)runMode: (of_run_loop_mode_t)mode beforeDate: (nullable OFDate *)deadline; -/*! +/** * @brief Stops the run loop. If there is still an operation being executed, it * is finished before the run loop stops. */ - (void)stop; @end OF_ASSUME_NONNULL_END