- docs updated

[strongswan.git] / Source / charon / queues / jobs / retransmit_request_job.h

diff --git a/Source/charon/queues/jobs/retransmit_request_job.h b/Source/charon/queues/jobs/retransmit_request_job.h
index 0573f04..b608526 100644 (file)
--- a/Source/charon/queues/jobs/retransmit_request_job.h
+++ b/Source/charon/queues/jobs/retransmit_request_job.h
@@ -31,7 +31,14 @@
 typedef struct retransmit_request_job_t retransmit_request_job_t;
 
 /**
 typedef struct retransmit_request_job_t retransmit_request_job_t;
 
 /**

- * Object representing an RETRANSMIT_REQUEST Job.
+ * @brief Class representing an RETRANSMIT_REQUEST Job.
+ * 
+ * This job is scheduled every time a request is sent over the
+ * wire. If the response to the request is not received at schedule
+ * time, the retransmission will be initiated.
+ * 
+ * @b Constructors:
+ * - retransmit_request_job_create()

  * 
  * @ingroup jobs
  */
  * 
  * @ingroup jobs
  */