summaryrefslogtreecommitdiffstats
path: root/cpukit/posix/include/rtems/posix/ptimer.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-15 09:54:10 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-15 09:54:10 -0500
commite49a36cb0b37cc3ad1c3f191fb439b17f6365539 (patch)
tree1c39de36e4c7a90413f55288ed86d076cef1afbf /cpukit/posix/include/rtems/posix/ptimer.h
parentlibcsupport: Update file header for termios.h to remove link, add description. (diff)
downloadrtems-e49a36cb0b37cc3ad1c3f191fb439b17f6365539.tar.bz2
posix: Doxygen Enhancement Task #5
http://www.google-melange.com/gci/task/view/google/gci2012/7959229
Diffstat (limited to 'cpukit/posix/include/rtems/posix/ptimer.h')
-rw-r--r--cpukit/posix/include/rtems/posix/ptimer.h12
1 files changed, 7 insertions, 5 deletions
diff --git a/cpukit/posix/include/rtems/posix/ptimer.h b/cpukit/posix/include/rtems/posix/ptimer.h
index a7c083711a..1b791cc915 100644
--- a/cpukit/posix/include/rtems/posix/ptimer.h
+++ b/cpukit/posix/include/rtems/posix/ptimer.h
@@ -88,13 +88,15 @@ int timer_gettime(
struct itimerspec *value
);
-/*
+/**
+ * @brief Get Overrun Count for a POSIX Per-Process Timer
+ *
+ * The expiration of a timer must increase by one a counter.
+ * After the signal handler associated to the timer finishes
+ * its execution, _POSIX_Timer_TSR will have to set this counter to 0.
+ *
* 14.2.4 Per-Process Timers, P1003.1b-1993, p. 267
- *
- * timer_getoverrun
- *
*/
-
int timer_getoverrun(
timer_t timerid
);