This is merely a historical archive of years 2008-2021, before the migration to mailman3.
A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.
Neels Hofmeyr gerrit-no-reply at lists.osmocom.orgReview at https://gerrit.osmocom.org/2986 doxygen: various fixes in core/timer.h Move a longish comment to the timer group so that it appears in the API doc. Un-doxygen some floating comments that were associated with unrelated code items ('/**' --> '/*'). Add braces to some function names so that the API doc will render as reference links. Change-Id: I3ea5b88cbe9cb54702429158bf47e768e04e8fe7 --- M include/osmocom/core/timer.h 1 file changed, 16 insertions(+), 19 deletions(-) git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/86/2986/1 diff --git a/include/osmocom/core/timer.h b/include/osmocom/core/timer.h index 28785db..a039ac8 100644 --- a/include/osmocom/core/timer.h +++ b/include/osmocom/core/timer.h @@ -19,11 +19,24 @@ */ /*! \defgroup timer Osmocom timers + * Timer management: + * - Create a struct osmo_timer_list + * - Fill out timeout and use osmo_timer_add(), or + * use osmo_timer_schedule() to schedule a timer in + * x seconds and microseconds from now... + * - Use osmo_timer_del() to remove the timer + * + * Internally: + * - We hook into select.c to give a timeval of the + * nearest timer. On already passed timers we give + * it a 0 to immediately fire after the select + * - osmo_timers_update() will call the callbacks and + * remove the timers. * @{ */ /*! \file timer.h - * Osmocom timer handling routines + * Osmocom timer handling routines. */ #pragma once @@ -34,22 +47,6 @@ #include <osmocom/core/linuxlist.h> #include <osmocom/core/linuxrbtree.h> -/** - * Timer management: - * - Create a struct osmo_timer_list - * - Fill out timeout and use add_timer or - * use osmo_timer_schedule to schedule a timer in - * x seconds and microseconds from now... - * - Use osmo_timer_del to remove the timer - * - * Internally: - * - We hook into select.c to give a timeval of the - * nearest timer. On already passed timers we give - * it a 0 to immediately fire after the select - * - osmo_timers_update will call the callbacks and - * remove the timers. - * - */ /*! A structure representing a single instance of a timer */ struct osmo_timer_list { struct rb_node node; /*!< rb-tree node header */ @@ -61,7 +58,7 @@ void *data; /*!< user data for callback */ }; -/** +/* * timer management */ @@ -88,7 +85,7 @@ int osmo_gettimeofday(struct timeval *tv, struct timezone *tz); -/** +/* * timer override */ -- To view, visit https://gerrit.osmocom.org/2986 To unsubscribe, visit https://gerrit.osmocom.org/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I3ea5b88cbe9cb54702429158bf47e768e04e8fe7 Gerrit-PatchSet: 1 Gerrit-Project: libosmocore Gerrit-Branch: master Gerrit-Owner: Neels Hofmeyr <nhofmeyr at sysmocom.de>