- docs updated

Source/charon/queues/jobs/delete_established_ike_sa_job.h

@@ -33,6 +33,9 @@ typedef struct delete_established_ike_sa_job_t delete_established_ike_sa_job_t;
 /**
  * @brief Class representing an DELETE_ESTABLISHED_IKE_SA Job.
  * 
+ * This job initiates the deletion of an IKE_SA. The SA
+ * to delete is specified via an ike_sa_id_t.
+ * 
  * @b Constructors:
  *  - delete_established_ike_sa_job_create()
  * 
@@ -66,7 +69,7 @@ struct delete_established_ike_sa_job_t {
  * @brief Creates a job of type DELETE_ESTABLISHED_IKE_SA.
  * 
  * @param ike_sa_id		id of the IKE_SA to delete
- * @return				created delete_established_ike_sa_job_t object
+ * @return				delete_established_ike_sa_job_t object
  * 
  * @ingroup jobs
  */

Source/charon/queues/jobs/delete_half_open_ike_sa_job.h

@@ -33,6 +33,10 @@ typedef struct delete_half_open_ike_sa_job_t delete_half_open_ike_sa_job_t;
 /**
  * @brief Class representing an DELETE_HALF_OPEN_IKE_SA Job.
  * 
+ * This job is responsible for deleting of half open IKE_SAs. A half 
+ * open IKE_SA is every IKE_SA which hasn't reache the ike_sa_established
+ * state.
+ * 
  * @b Constructors:
  *  - delete_half_open_ike_sa_job_create()
  * 

Source/charon/queues/jobs/incoming_packet_job.h

@@ -31,7 +31,13 @@
 typedef struct incoming_packet_job_t incoming_packet_job_t;
 
 /**
- * @brief Object representing an INCOMING_PACKET Job.
+ * @brief Class representing an INCOMING_PACKET Job.
+ * 
+ * An incoming pack job is created from the receiver, which has
+ * read a packet to process from the socket.
+ * 
+ * @b Constructors:
+ * - incoming_packet_job_create()
  * 
  * @ingroup jobs
  */

Source/charon/queues/jobs/initiate_ike_sa_job.h

@@ -28,7 +28,13 @@
 typedef struct initiate_ike_sa_job_t initiate_ike_sa_job_t;
 
 /**
- * Object representing an INITIATE_IKE_SA Job
+ * @brief Class representing an INITIATE_IKE_SA Job.
+ * 
+ * This job is created if an IKE_SA should be iniated. This 
+ * happens form a user request, or via the kernel interface.
+ * 
+ * @b Constructors:
+ * - initiate_ike_sa_job_create()
  * 
  * @ingroup jobs
  */
@@ -39,14 +45,14 @@ struct initiate_ike_sa_job_t {
 	job_t job_interface;
 	
 	/**
-	 * @brief Returns the currently set configuration name for this job
+	 * @brief Returns the currently set configuration name for this job.
 	 * 	
 	 * @warning Returned name is not copied.
 	 * 
 	 * @param this 	calling initiate_ike_sa_job_t object
 	 * @return 		name of the configuration
 	 */
-	char * (*get_configuration_name) (initiate_ike_sa_job_t *this);
+	char *(*get_configuration_name) (initiate_ike_sa_job_t *this);
 
 	/**
 	 * @brief Destroys an initiate_ike_sa_job_t object.

Source/charon/queues/jobs/job.h

@@ -32,6 +32,8 @@ typedef enum job_type_t job_type_t;
 /**
  * @brief Definition of the various job types.
  * 
+ * @todo add more jobs, such as rekeying.
+ * 
  * @ingroup jobs
  */
 enum job_type_t {
@@ -52,8 +54,8 @@ enum job_type_t {
 	 * 
 	 * Job is implemented in class type initiate_ike_sa_job_t
 	 */
-	
 	INITIATE_IKE_SA,
+	
 	/** 
 	 * Delete an ike sa which is still not established.
 	 * 
@@ -67,13 +69,12 @@ enum job_type_t {
 	 * Job is implemented in class type delete_established_ike_sa_job_t
 	 */	
 	DELETE_ESTABLISHED_IKE_SA
-	
-	
-	/* more job types have to be inserted here */
 };
 
 /**
  * string mappings for job_type_t
+ * 
+ * @ingroup jobs
  */
 extern mapping_t job_type_m[];
 
@@ -85,6 +86,9 @@ typedef struct job_t job_t;
  * 
  * A job consists of a job-type and one or more assigned values.
  * 
+ * @b Constructors:
+ * - None, use specific implementation of the interface.
+ * 
  * @ingroup jobs
  */
 struct job_t {

Source/charon/queues/jobs/retransmit_request_job.h

@@ -31,7 +31,14 @@
 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
  */