aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/threads/sender.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/charon/threads/sender.h')
-rw-r--r--Source/charon/threads/sender.h11
1 files changed, 7 insertions, 4 deletions
diff --git a/Source/charon/threads/sender.h b/Source/charon/threads/sender.h
index 1192ef76e..ea8124147 100644
--- a/Source/charon/threads/sender.h
+++ b/Source/charon/threads/sender.h
@@ -28,16 +28,19 @@
typedef struct sender_t sender_t;
/**
- * @brief Sends packets over the socket.
+ * @brief Thread responsible for sending packets over the socket.
+ *
+ * @b Constructors:
+ * - sender_create()
*
* @ingroup threads
*/
struct sender_t {
/**
- * @brief Destroys a sender object
+ * @brief Destroys a sender object.
*
- * @param sender sender object
+ * @param sender calling object
*/
void (*destroy) (sender_t *sender);
};
@@ -50,7 +53,7 @@ struct sender_t {
* from the send queue and sends them out.
*
* @return
- * - created sender_t, or
+ * - sender_t object
* - NULL of thread could not be started
*
* @ingroup threads