Cleanup indentation with clang-format and changed a few variable names

src/util/timer.h

@@ -1,4 +1,4 @@
-/**************************************************************************
+/*************************************************************************
 *
 * Copyright (C) 2009 Andreas.Fink (Andreas.Fink85@gmail.com)
 *
@@ -15,7 +15,6 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 **************************************************************************/
 
-
 #ifndef TIMER_H
 #define TIMER_H
 
@@ -23,59 +22,51 @@
 #include <time.h>
 #include <sys/time.h>
 
+// Single shot timers (i.e. timers with interval_msec == 0) are deleted automatically as soon as they expire,
+// i.e. you do not need to stop them, however it is safe to call stop_timeout for these timers.
+// You can pass the address of the variable storing the pointer to the timer as 'self' in add_timeout, in which
+// case it is used to clear the pointer if the timer is destroyed automatically. This enforces the timeout pointers
+// to be either valid or NULL.
+// Periodic timeouts are aligned to each other whenever possible, i.e. one interval_msec is an
+// integral multiple of the other.
+
 extern struct timeval next_timeout;
-
-
 typedef struct _timeout timeout;
 
-
-// timer functions
-/**
-  * Single shot timers (i.e. timers with interval_msec == 0) are deleted automatically as soon as they expire,
-  * i.e. you do not need to stop them, however it is safe to call stop_timeout for these timers.
-  * You can pass the address of the variable storing the pointer to the timer as 'self' in add_timeout, in which
-  * case it is used to clear the pointer if the timer is destroyed automatically. This enforces the timeout pointers
-  * to be either valid or NULL.
-  * Periodic timeouts are aligned to each other whenever possible, i.e. one interval_msec is an
-  * integral multiple of the other.
-**/
-
-/** Initializes default global data. **/
+// Initializes default global data.
 void default_timeout();
 
-/** Cleans up: stops all timers and frees memory. **/
+// Cleans up: stops all timers and frees memory.
 void cleanup_timeout();
 
-/** Installs a timer with the first timeout after 'value_msec' and then an optional periodic timeout every
-  * 'interval_msec' (set it to 0 to prevent periodic timeouts).
-  * '_callback' is the function called when the timer reaches the timeout.
-  * 'arg' is the argument passed to the callback function.
-  * 'self' is an optional pointer to a timeout* variable. If non-NULL, the variable is set to NULL when the timer
-  * is destroyed (with stop_timeout, cleanup_timeout or when the timer expires and it is single-shot).
-  * Returns a pointer to the timer, which is needed for stopping/changing it.
-**/
-timeout* add_timeout(int value_msec, int interval_msec, void (*_callback)(void*), void* arg, timeout **self);
+// Installs a timer with the first timeout after 'value_msec' and then an optional periodic timeout every
+// 'interval_msec' (set it to 0 to prevent periodic timeouts).
+// '_callback' is the function called when the timer reaches the timeout.
+// 'arg' is the argument passed to the callback function.
+// 'self' is an optional pointer to a timeout* variable. If non-NULL, the variable is set to NULL when the timer
+// is destroyed (with stop_timeout, cleanup_timeout or when the timer expires and it is single-shot).
+// Returns a pointer to the timer, which is needed for stopping/changing it.
+timeout *add_timeout(int value_msec, int interval_msec, void (*_callback)(void *), void *arg, timeout **self);
 
-/** Changes timer 't'. If it does not exist, a new timer is created, with self set to 't'. **/
-void change_timeout(timeout** t, int value_msec, int interval_msec, void (*_callback)(void*), void* arg);
+// Changes timer 't'. If it does not exist, a new timer is created, with self set to 't'.
+void change_timeout(timeout **t, int value_msec, int interval_msec, void (*_callback)(void *), void *arg);
 
-/** stops the timeout 't' **/
-void stop_timeout(timeout* t);
+// Stops the timer 't'
+void stop_timeout(timeout *t);
 
-/** update_next_timeout updates next_timeout to the value, when the next installed timeout will expire **/
+// Updates next_timeout to the value, when the next installed timeout will expire
 void update_next_timeout();
 
-/** Callback of all expired timeouts **/
+// Callback of all expired timeouts
 void callback_timeout_expired();
 
-/** Returns -1 if t1 < t2, 0 if t1 == t2, 1 if t1 > t2 **/
-gint compare_timespecs(const struct timespec* t1, const struct timespec* t2);
+// Returns -1 if t1 < t2, 0 if t1 == t2, 1 if t1 > t2
+gint compare_timespecs(const struct timespec *t1, const struct timespec *t2);
 
 struct timespec add_msec_to_timespec(struct timespec ts, int msec);
 
-/** Returns the time difference in seconds between the current time and the last time this function was called.
-  * At the first call returns zero.
-**/
+// Returns the time difference in seconds between the current time and the last time this function was called.
+// At the first call returns zero.
 double profiling_get_time();
 
 #endif // TIMER_H