diff options
| author | Vincent Sanders <vince@kyllikki.org> | 2014-11-29 16:20:40 +0000 |
|---|---|---|
| committer | Vincent Sanders <vince@kyllikki.org> | 2014-11-29 16:20:40 +0000 |
| commit | b662aee6b4a7743ba9ea904ff307ae9d3497bc2d (patch) | |
| tree | 7e656a453c4a23b3a2aa619bc27ff02c3d6fa85b /include | |
| parent | 2b03e4ea2f63bff82fb7caae455533bb9045bfbf (diff) | |
| download | libnsutils-b662aee6b4a7743ba9ea904ff307ae9d3497bc2d.tar.gz libnsutils-b662aee6b4a7743ba9ea904ff307ae9d3497bc2d.tar.bz2 | |
Improve and document exact behaviour of the returned value.
Diffstat (limited to 'include')
| -rw-r--r-- | include/nsutils/time.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/include/nsutils/time.h b/include/nsutils/time.h index 93a4c1d..aa39d94 100644 --- a/include/nsutils/time.h +++ b/include/nsutils/time.h @@ -18,10 +18,14 @@ #include <nsutils/errors.h> /** - * Get a monotonically incrementing number of milliseconds. + * Get a monotonically incriminating number of milliseconds. * - * Obtain a count of elapsed time in milliseconds. Unlike gettimeofday this - * will continue linearly across time setting and not go backwards, + * Obtain a count of elapsed time in milliseconds from an arbitrary point in + * time. Unlike gettimeofday this will continue linearly across time setting + * and not go backwards. + * + * \note The read value will always increment by at least 1 on each call meaning + * times less than 1ms cannot be differentiated. * * \param current The current value of the counter. * \return NSERROR_OK on success else error code. |