diff options
| author | Nick Mathewson <nickm@torproject.org> | 2008-12-22 14:56:28 +0000 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2008-12-22 14:56:28 +0000 |
| commit | 1725c0c8a50cb4de34157aee720af6753821f80c (patch) | |
| tree | ff61e0f1234abc1a087456869a929d8a88d19463 /src/common/util.c | |
| parent | ef1be06de6d47daea90f8fccf9d627d083d4c071 (diff) | |
| download | tor-1725c0c8a50cb4de34157aee720af6753821f80c.tar tor-1725c0c8a50cb4de34157aee720af6753821f80c.tar.gz | |
Add DOCDOC comments for all undocumented functions. Add missing *s to other comments so that they will get recognized as doxygen.
svn:r17729
Diffstat (limited to 'src/common/util.c')
| -rw-r--r-- | src/common/util.c | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/src/common/util.c b/src/common/util.c index 659766a4e..d40de03ce 100644 --- a/src/common/util.c +++ b/src/common/util.c @@ -1341,12 +1341,14 @@ update_approx_time(time_t now) */ static int ftime_skew = 0; static int ftime_slop = 60; +/* DOCDOC ftime_set_maximum_sloppiness */ void ftime_set_maximum_sloppiness(int seconds) { tor_assert(seconds >= 0); ftime_slop = seconds; } +/* DOCDOC ftime_set_estimated_skew */ void ftime_set_estimated_skew(int seconds) { @@ -1360,18 +1362,21 @@ ftime_get_window(time_t now, ftime_t *ft_out) ft_out->latest = now + ftime_skew + ftime_slop; } #endif +/* DOCDOC ftime_maybe_after */ int ftime_maybe_after(time_t now, time_t when) { /* It may be after when iff the latest possible current time is after when */ return (now + ftime_skew + ftime_slop) >= when; } +/* DOCDOC ftime_maybe_before */ int ftime_maybe_before(time_t now, time_t when) { /* It may be before when iff the earliest possible current time is before */ return (now + ftime_skew - ftime_slop) < when; } +/* DOCDOC ftime_definitely_after */ int ftime_definitely_after(time_t now, time_t when) { @@ -1379,6 +1384,7 @@ ftime_definitely_after(time_t now, time_t when) * after when. */ return (now + ftime_skew - ftime_slop) >= when; } +/* DOCDOC ftime_definitely_before */ int ftime_definitely_before(time_t now, time_t when) { @@ -1941,7 +1947,7 @@ read_file_to_str(const char *filename, int flags, struct stat *stat_out) #define TOR_ISODIGIT(c) ('0' <= (c) && (c) <= '7') -/* Given a c-style double-quoted escaped string in <b>s</b>, extract and +/** Given a c-style double-quoted escaped string in <b>s</b>, extract and * decode its contents into a newly allocated string. On success, assign this * string to *<b>result</b>, assign its length to <b>size_out</b> (if * provided), and return a pointer to the position in <b>s</b> immediately |