aboutsummaryrefslogtreecommitdiffstats
path: root/src/timer.c
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2012-12-06 21:25:27 +0100
committerHarald Welte <laforge@gnumonks.org>2013-01-11 09:43:32 +0100
commitde6e4983e7f83794e45af5a70b036ed9f4437ab5 (patch)
treea742ef30f0d1bd0a774eadad6546311773627b79 /src/timer.c
parent9043fe57e8852ac4693fe25b887246f2c23aa688 (diff)
add some missing doxygen annotation for libosmocore functions
Diffstat (limited to 'src/timer.c')
-rw-r--r--src/timer.c12
1 files changed, 5 insertions, 7 deletions
diff --git a/src/timer.c b/src/timer.c
index 6d4abc26..98cbf6e6 100644
--- a/src/timer.c
+++ b/src/timer.c
@@ -154,7 +154,9 @@ int osmo_timer_remaining(const struct osmo_timer_list *timer,
return 0;
}
-/*
+/*! \brief Determine time between now and the nearest timer
+ * \returns pointer to timeval of nearest timer, NULL if there is none
+ *
* if we have a nearest time return the delta between the current
* time and the time of the nearest timer.
* If the nearest timer timed out return NULL and then we will
@@ -184,9 +186,7 @@ static void update_nearest(struct timeval *cand, struct timeval *current)
}
}
-/*
- * Find the nearest time and update s_nearest_time
- */
+/*! \brief Find the nearest time and update nearest_p */
void osmo_timers_prepare(void)
{
struct rb_node *node;
@@ -204,9 +204,7 @@ void osmo_timers_prepare(void)
}
}
-/*
- * fire all timers... and remove them
- */
+/*! \brief fire all timers... and remove them */
int osmo_timers_update(void)
{
struct timeval current_time;