diff options
author | Vincent Sanders <vince@kyllikki.org> | 2014-07-02 16:39:08 +0100 |
---|---|---|
committer | Vincent Sanders <vince@kyllikki.org> | 2014-07-02 16:39:08 +0100 |
commit | 8848f754e07264a8b358c34048d84139660291d1 (patch) | |
tree | 4a7331647120f9442a288cbf8a7e66c2256a27ee /atari/schedule.h | |
parent | 29e29cccd772c7be1b5cc878313287307ed7490f (diff) | |
download | netsurf-8848f754e07264a8b358c34048d84139660291d1.tar.gz netsurf-8848f754e07264a8b358c34048d84139660291d1.tar.bz2 |
documentation fixes and cleanups
Diffstat (limited to 'atari/schedule.h')
-rwxr-xr-x | atari/schedule.h | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/atari/schedule.h b/atari/schedule.h index 47d8c2ddf..05eebb2d7 100755 --- a/atari/schedule.h +++ b/atari/schedule.h @@ -22,20 +22,23 @@ /** * Process events up to current time. + * + * \return The number of miliseconds until the next scheduled event. */ int schedule_run(void); /** * Schedule a callback. * - * \param tival interval before the callback should be made in ms - * \param callback callback function - * \param p user parameter, passed to callback function + * \param ival interval before the callback should be made in miliseconds. + * \param callback callback function. + * \param p user parameter, passed to callback function. + * \return NSERROR_OK on success or appropriate error code. * - * The callback function will be called as soon as possible after t ms have - * passed. + * The callback function will be called as soon as possible after \a ival + * ms have passed. */ -nserror atari_schedule(int cs_ival, void (*callback)(void *p), void *p); +nserror atari_schedule(int ival, void (*callback)(void *p), void *p); /** * LOG all current scheduled events. |