Add wrapper macros for pset_first() and pset_next(), which have the return type as...

[libfirm] / include / libfirm / timing.h

diff --git a/include/libfirm/timing.h b/include/libfirm/timing.h
index d9da1ab..282e4ec 100644 (file)
--- a/include/libfirm/timing.h
+++ b/include/libfirm/timing.h
@@ -20,7 +20,6 @@
 /**
  * @file
  * @brief    platform neutral timing utilities
- * @version  $Id: tv.h 17143 2008-01-02 20:56:33Z beck $
  */
 #ifndef FIRM_TIMING_H
 #define FIRM_TIMING_H
@@ -29,7 +28,13 @@
 
 #include "begin.h"
 
-typedef struct _ir_timer_t ir_timer_t;
+/**
+ * A timer
+ *
+ * A timer can be started/stopped multiple times and measures the (wallclock)
+ * time spent between start and stop calls.
+ */
+typedef struct ir_timer_t ir_timer_t;
 
 /**
  * Switch to real-time scheduling.
@@ -48,7 +53,7 @@ FIRM_API int ir_timer_enter_high_priority(void);
 FIRM_API int ir_timer_leave_high_priority(void);
 
 /**
- * Get the amount of bytes allocated on the heap.
+ * Returns the amount of bytes allocated on the heap.
  * @return The number of bytes allocated on the heap.
  */
 FIRM_API size_t ir_get_heap_used_bytes(void);
@@ -56,6 +61,7 @@ FIRM_API size_t ir_get_heap_used_bytes(void);
 /**
  * Create a new timer
  * @return The timer.
+ * @see #ir_timer_t
  */
 FIRM_API ir_timer_t *ir_timer_new(void);
 
@@ -107,33 +113,19 @@ FIRM_API int ir_timer_push(ir_timer_t *timer);
 FIRM_API ir_timer_t *ir_timer_pop(void);
 
 /**
- * Get the number of milliseconds, the timer has elapsed.
+ * Returns the number of milliseconds, the timer has elapsed.
  * @param timer The timer.
  * @return The number of milliseconds the timer is (was) running.
  */
 FIRM_API unsigned long ir_timer_elapsed_msec(const ir_timer_t *timer);
 
 /**
- * Get the number of microseconds, the timer has elapsed.
+ * Returns the number of microseconds, the timer has elapsed.
  * @param timer The timer.
  * @return The number of milliseconds the timer is (was) running.
  */
 FIRM_API unsigned long ir_timer_elapsed_usec(const ir_timer_t *timer);
 
-/**
- * Get name of given timer.
- * @param timer The timer.
- * @return The name of the timer.
- */
-FIRM_API const char *ir_timer_get_name(const ir_timer_t *timer);
-
-/**
- * Get description of given timer.
- * @param timer The timer.
- * @return The description of the timer.
- */
-FIRM_API const char *ir_timer_get_description(const ir_timer_t *timer);
-
 #include "end.h"
 
 #endif