X-Git-Url: https://git.strongswan.org/?p=strongswan.git;a=blobdiff_plain;f=Source%2Fcharon%2Fqueues%2Fevent_queue.h;h=a60424100ddc87d376b9874573b2ebac168b1638;hp=41700cf17f5e84b37f1f70114337209f9c1dcfdc;hb=a6cbf648312606089d352b8d3dda4ada66445603;hpb=3febcf15f0cba8b17ab3bdb67c3d0864ef61080c

diff --git a/Source/charon/queues/event_queue.h b/Source/charon/queues/event_queue.h
index 41700cf..a604241 100644
--- a/Source/charon/queues/event_queue.h
+++ b/Source/charon/queues/event_queue.h
@@ -32,10 +32,18 @@ typedef struct event_queue_t event_queue_t;
 
 /**
  * @brief Event-Queue used to store timed events.
+ * 
+ * Added events are sorted. The get method blocks until
+ * the time is elapsed to process the next event. The get 
+ * method is called from the scheduler_t thread, which
+ * will add the jobs to to job_queue_t for further processing.
  *
  * Although the event-queue is based on a linked_list_t
  * all access functions are thread-save implemented.
  * 
+ * @b Constructors:
+ * - event_queue_create()
+ * 
  * @ingroup queues
  */
 struct event_queue_t {
@@ -93,15 +101,14 @@ struct event_queue_t {
 	 * after calling this function.
 	 *
 	 * @param event_queue 	calling object
-	 * @returns				always SUCCESS
 	 */
 	void (*destroy) (event_queue_t *event_queue);
 };
 
 /**
- * @brief Creates an empty event_queue
+ * @brief Creates an empty event_queue.
  *
- * @returns		event_queue
+ * @returns event_queue_t object
  * 
  * @ingroup queues
  */