diff options
| -rw-r--r-- | src/lib/eina/eina_sched.h | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/src/lib/eina/eina_sched.h b/src/lib/eina/eina_sched.h index 43f32b9c7b..13f35a4476 100644 --- a/src/lib/eina/eina_sched.h +++ b/src/lib/eina/eina_sched.h @@ -16,6 +16,16 @@ * if not, see <http://www.gnu.org/licenses/>. */ +/** + * @defgroup Schedule Schedule + * @ingroup Eina_Tools_Group + * + * @{ + * + * TODO: description + * + */ + #ifndef EINA_SCHED_H_ #define EINA_SCHED_H_ @@ -23,17 +33,21 @@ /** - * @brief Lower priority of current thread. + * @brief Lowers the priority of the current thread. * - * It's used by worker threads so they use up background cpu and do not stall - * the main thread If current thread is running with real-time priority, we - * decrease our priority by @c RTNICENESS. This is done in a portable way. + * @details It's used by worker threads so that they use up the background CPU and do not stall + * the main thread. If the current thread is running with real-time priority, we + * decrease our priority by @c RTNICENESS. This is done in a portable way. * - * Otherwise (we are running with SCHED_OTHER policy) there's no portable way to - * set the nice level on current thread. In Linux, it does work and it's the - * only one that is implemented as of now. In this case the nice level is - * incremented on this thread by @c NICENESS. + * Otherwise, (we are running with the SCHED_OTHER policy) there's no portable way to + * set the nice level on the current thread. In Linux, it does work and it's the + * only one that is implemented as of now. In this case, the nice level is + * incremented on this thread by @c NICENESS. */ EAPI void eina_sched_prio_drop(void); +/** + * @} + */ + #endif /* EINA_SCHED_H_ */ |