Commit cccde2bc authored by Pekka Pessi's avatar Pekka Pessi

su_time.c: updated documentation.

darcs-hash:20061222154232-65a35-4dbd741170d150228f18120c8a4ed0c66f0a86c5.gz
parent ebcbe55e
......@@ -165,17 +165,16 @@ int su_time_print(char *s, int n, su_time_t const *tv)
/** Time difference in milliseconds.
*
* Calculates the duration from t2 to t1 in milliseconds.
* Calculates the duration from t2 to t1 in milliseconds.
*
* @param t1 after time
* @param t2 before time
*
* @return
* The duration in milliseconds between the two times. If the difference
* is bigger than @c SU_DURATION_MAX, the function su_duration() returns
* @c SU_DURATION_MAX instead. If the difference is smaller than @c
* -SU_DURATION_MAX, the function su_duration() returns @c
* -SU_DURATION_MAX.
* @return The duration in milliseconds between the two times.
* If the difference is bigger than #SU_DURATION_MAX, return #SU_DURATION_MAX
* instead.
* If the difference is smaller than -#SU_DURATION_MAX, return
* -#SU_DURATION_MAX.
*/
su_duration_t su_duration(su_time_t const t1, su_time_t const t2)
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment