- docs updated
[strongswan.git] / Source / charon / queues / send_queue.h
index f023f29..6dc5867 100644 (file)
 typedef struct send_queue_t send_queue_t;
 
 /**
- * @brief Send-Queue
- *
+ * @brief The send queue stores packet for the sender_t instance.
+ * 
+ * The sender_t will send them consequently over the wire.
  * Although the send-queue is based on a linked_list_t
- * all access functions are thread-save implemented
+ * all access functions are thread-save implemented.
+ * 
+ * @b Constructors:
+ * - send_queue_create()
+ * 
+ * @ingroup queues
  */
 struct send_queue_t {
 
@@ -54,7 +60,7 @@ struct send_queue_t {
         * After using, the returned packet has to get destroyed by the caller.
         *
         * @param send_queue_t  calling object
-        * @param[out] packet   pointer to a packet_t pointer where to packet is returned to
+        * @return                              next packet from the queue
         */
        packet_t *(*get) (send_queue_t *send_queue);
 
@@ -77,8 +83,7 @@ struct send_queue_t {
         * that no thread is going to add or get a packet from the send_queue
         * after calling this function.
         *
-        * @param send_queue_t calling object
-        * @returns SUCCESS if succeeded, FAILED otherwise
+        * @param send_queue_t  calling object
         */
        void (*destroy) (send_queue_t *send_queue);
 };
@@ -86,7 +91,9 @@ struct send_queue_t {
 /**
  * @brief Creates an empty send_queue_t.
  *
- * @return send_queue_t empty send_queue_t
+ * @return send_queue_t object
+ * 
+ * @ingroup queues
  */
 send_queue_t *send_queue_create();