doxy -> .h

SVN revision: 58442
This commit is contained in:
Carsten Haitzler 2011-04-07 13:05:05 +00:00
parent 4bbfbb6b33
commit 14478ee124
4 changed files with 37 additions and 36 deletions

View File

@ -64,6 +64,30 @@
* @{
*/
/**
* @addtogroup Eina_Safety_Checks_Group Safety Checks
*
* Safety checks are a set of macros to check for parameters or values
* that should never happen, it is similar in concept to assert(), but
* will log and return instead of abort() your program.
*
* Since these cases should never happen, one may wantto keep safety
* checks enabled during tests but disable then during deploy, not
* doing any checks at all. This is a common requirement for embedded
* systems. Whenever to check or not should be set during compile time
* by using @c --disable-safety-checks or @c --enable-safety-checks
* options to @c configure script.
*
* Whenever these macros capture an error, EINA_LOG_ERR() will be
* called and @c eina_error set to @c EINA_ERROR_SAFETY_FAILED and can
* be checked with eina_error_get() after call.
*
* @see EINA_SAFETY_ON_NULL_RETURN(), EINA_SAFETY_ON_NULL_RETURN_VAL()
* and other macros.
*
* @{
*/
#include "eina_config.h"
#include "eina_error.h"

View File

@ -21,6 +21,19 @@
#include "eina_types.h"
/**
* @brief Lower priority of 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.
*
* 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.
*/
EAPI void eina_sched_prio_drop(void);
#endif /* EINA_SCHED_H_ */

View File

@ -54,30 +54,6 @@ eina_safety_checks_shutdown(void)
* API *
*============================================================================*/
/**
* @addtogroup Eina_Safety_Checks_Group Safety Checks
*
* Safety checks are a set of macros to check for parameters or values
* that should never happen, it is similar in concept to assert(), but
* will log and return instead of abort() your program.
*
* Since these cases should never happen, one may wantto keep safety
* checks enabled during tests but disable then during deploy, not
* doing any checks at all. This is a common requirement for embedded
* systems. Whenever to check or not should be set during compile time
* by using @c --disable-safety-checks or @c --enable-safety-checks
* options to @c configure script.
*
* Whenever these macros capture an error, EINA_LOG_ERR() will be
* called and @c eina_error set to @c EINA_ERROR_SAFETY_FAILED and can
* be checked with eina_error_get() after call.
*
* @see EINA_SAFETY_ON_NULL_RETURN(), EINA_SAFETY_ON_NULL_RETURN_VAL()
* and other macros.
*
* @{
*/
/**
* @cond LOCAL
*/

View File

@ -36,18 +36,6 @@
#define RTNICENESS 5
#define NICENESS 5
/**
* @brief Lower priority of 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.
*
* 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.
*/
EAPI void
eina_sched_prio_drop(void)
{