Improve documentation

This commit is contained in:
Nils O. Selåsdal
2013-05-21 00:24:07 +02:00
parent 120299d7c3
commit f2bbca8718
+5
View File
@@ -93,6 +93,8 @@ void uc_settable_clock_init(struct UCoreSettableClock *uclock);
/** /**
* Set the new timeval this clock will return * Set the new timeval this clock will return
*
* @param tv new timeval to set the clock to
**/ **/
void uc_settable_clock_set_tv(struct UCoreSettableClock *uclock, void uc_settable_clock_set_tv(struct UCoreSettableClock *uclock,
const struct timeval *tv); const struct timeval *tv);
@@ -101,6 +103,9 @@ void uc_settable_clock_set_tv(struct UCoreSettableClock *uclock,
* Set the new time this clock will return * Set the new time this clock will return
* Convenience function that takes seconds/microseconds as arguments * Convenience function that takes seconds/microseconds as arguments
* instead of a struct timeval. * instead of a struct timeval.
*
* @param secs seconds portion of the clock to set
* @param usecs microseconds portion of the clock to set.
**/ **/
void uc_settable_clock_set(struct UCoreSettableClock *uclock, void uc_settable_clock_set(struct UCoreSettableClock *uclock,
time_t secs, suseconds_t usecs); time_t secs, suseconds_t usecs);