Adapting comments to Doxygen formatting (adding \n and separating lines).

[frescor/frsh-forb.git] / include / fosa_clocks_and_timers.h

diff --git a/include/fosa_clocks_and_timers.h b/include/fosa_clocks_and_timers.h
index 5851f1078975e94d76bf27126ad32ac9a9930bdc..9f485f87f7248294081ab03b4ccd82ffad19d2f5 100644 (file)
--- a/include/fosa_clocks_and_timers.h
+++ b/include/fosa_clocks_and_timers.h
@@ -92,7 +92,7 @@
  * fosa_get_cputime_clock()
  *
  * Returns 0 if successful; otherwise it returns an error code:
- *     EINVAL: the value of clockid is invalid
+ *     FOSA_EINVAL: the value of clockid is invalid
  *
  * Alternatively, in case of error the implementation is allowed to
  * notify it to the system console and then terminate the FRSH
@@ -110,7 +110,7 @@ int fosa_clock_get_time(fosa_clock_id_t clockid, struct timespec *current_time);
  * identifier of a cpu-time clock for the thread specified by tid.
  *
  * Returns 0 if successful; otherwise it returns an error code:
- *    EINVAL: the value of tid is invalid
+ *    FOSA_EINVAL: the value of tid is invalid
  * 
  * Alternatively, in case of error the implementation is allowed to
  * notify it to the system console and then terminate the FRSH
@@ -148,9 +148,9 @@ int fosa_thread_get_cputime_clock(frsh_thread_id_t tid, fosa_clock_id_t *clockid
  * thread be the one who is waiting for the signal. 
  * 
  * Returns 0 if successful; otherwise it returns an error code:
- *     EINVAL: the value of clockid or signal is invalid
+ *     FOSA_EINVAL: the value of clockid or signal is invalid
  * 
- *     EAGAIN: the system lacks enough resources to create the timer
+ *     FOSA_EAGAIN: the system lacks enough resources to create the timer
  *
  * Alternatively, in case of error the implementation is allowed to
  * notify it to the system console and then terminate the FRSH
@@ -170,7 +170,7 @@ int fosa_thread_get_cputime_clock(frsh_thread_id_t tid, fosa_clock_id_t *clockid
  * deletion.
  * 
  * Returns 0 if successful; otherwise it returns an error code:
- *     EINVAL: the value of timerid is not valid
+ *     FOSA_EINVAL: the value of timerid is not valid
  *
  * Alternatively, in case of error the implementation is allowed to
  * notify it to the system console and then terminate the FRSH
@@ -201,7 +201,7 @@ int fosa_timer_delete(fosa_timer_id_t timerid);
  * When the timer expires, it is disarmed.
  *
  * Returns 0 if successful; otherwise it returns an error code:
- *    EINVAL: the value of timerid or value is invalid
+ *    FOSA_EINVAL: the value of timerid or value is invalid
  *
  * Alternatively, in case of error the implementation is allowed to
  * notify it to the system console and then terminate the FRSH
@@ -223,7 +223,7 @@ int fosa_timer_arm
  * If the timer is disarmed it returns 0.
  *
  * Returns 0 if successful; otherwise it returns an error code:
- *    EINVAL: the value of timerid or value is invalid
+ *    FOSA_EINVAL: the value of timerid or value is invalid
  *
  * Alternatively, in case of error the implementation is allowed to
  * notify it to the system console and then terminate the FRSH
@@ -249,7 +249,7 @@ int fosa_timer_get_remaining_time
  * disarmed a 0 value will be set.
  *
  * Returns 0 if successful; otherwise it returns an error code:
- *    EINVAL: the value of timerid or value is invalid
+ *    FOSA_EINVAL: the value of timerid or value is invalid
  *
  * Alternatively, in case of error the implementation is allowed to
  * notify it to the system console and then terminate the FRSH