- docs updated
[strongswan.git] / Source / charon / queues / jobs / initiate_ike_sa_job.h
index a5bbc93..ec6e4c1 100644 (file)
@@ -1,8 +1,7 @@
 /**
  * @file initiate_ike_sa_job.h
  * 
- * @brief Job of type INITIATE_IKE_SA
- * 
+ * @brief Interface of initiate_ike_sa_job_t.
  */
 
 /*
 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
  */
 struct initiate_ike_sa_job_t {
        /**
@@ -39,32 +45,30 @@ 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.
         *
         * @param this  initiate_ike_sa_job_t object to destroy
-        * @return              
-        *                              SUCCESS in any case
         */
-       status_t (*destroy) (initiate_ike_sa_job_t *this);
+       void (*destroy) (initiate_ike_sa_job_t *this);
 };
 
 /**
- * Creates a job of type INITIATE_IKE_SA
+ * @brief Creates a job of type INITIATE_IKE_SA.
  * 
  * @param configuration_name           name of the configuration to initiate IKE_SA with
- * @return
- *                             - initiate_ike_sa_job_t if successfully
- *                             - NULL if out of ressources or no configuration_name given
+ * @return                                                     initiate_ike_sa_job_t object
+ * 
+ * @ingroup jobs
  */
 initiate_ike_sa_job_t *initiate_ike_sa_job_create(char *configuration_name);