merged the modularization branch (credentials) back to trunk

src/charon/processing/jobs/acquire_job.c

@@ -1,10 +1,3 @@
-/**
- * @file acquire_job.c
- * 
- * @brief Implementation of acquire_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2006 Martin Willi
  * Hochschule fuer Technik Rapperswil
@@ -18,6 +11,8 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
 
 #include "acquire_job.h"

src/charon/processing/jobs/acquire_job.h

@@ -1,10 +1,3 @@
-/**
- * @file acquire_job.h
- * 
- * @brief Interface of acquire_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2006 Martin Willi
  * Hochschule fuer Technik Rapperswil
@@ -18,6 +11,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup acquire_job acquire_job
+ * @{ @ingroup jobs
  */
 
 #ifndef ACQUIRE_JOB_H_
@@ -29,14 +29,9 @@ typedef struct acquire_job_t acquire_job_t;
 #include <processing/jobs/job.h>
 
 /**
- * @brief Class representing an ACQUIRE Job.
+ * Class representing an ACQUIRE Job.
  * 
  * This job initiates a CHILD SA on kernel request.
- * 
- * @b Constructors:
- *  - acquire_job_create()
- * 
- * @ingroup jobs
  */
 struct acquire_job_t {
 	/**
@@ -46,15 +41,13 @@ struct acquire_job_t {
 };
 
 /**
- * @brief Creates a job of type ACQUIRE.
+ * Creates a job of type ACQUIRE.
  *
  * We use the reqid to find the routed CHILD_SA.
  *
  * @param reqid		reqid of the CHILD_SA to acquire
  * @return			acquire_job_t object
- * 
- * @ingroup jobs
  */
 acquire_job_t *acquire_job_create(u_int32_t reqid);
 
-#endif /* REKEY_CHILD_SA_JOB_H_ */
+#endif /* REKEY_CHILD_SA_JOB_H_ @} */

src/charon/processing/jobs/callback_job.c

@@ -1,10 +1,3 @@
-/**
- * @file callback_job.c
- * 
- * @brief Implementation of callback_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2007 Martin Willi
  * Hochschule fuer Technik Rapperswil
@@ -18,6 +11,8 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
  
 #include "callback_job.h"

src/charon/processing/jobs/callback_job.h

@@ -1,10 +1,3 @@
-/**
- * @file callback_job.h
- * 
- * @brief Interface of callback_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2007 Martin Willi
  * Hochschule fuer Technik Rapperswil
@@ -18,6 +11,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup callback_job callback_job
+ * @{ @ingroup jobs
  */
 
 #ifndef CALLBACK_JOB_H_
@@ -32,12 +32,10 @@ typedef struct callback_job_t callback_job_t;
 typedef enum job_requeue_t job_requeue_t;
 
 /**
- * @brief Job requeueing policy
+ * Job requeueing policy
  *
  * The job requeueing policy defines how a job is handled when the callback
  * function returns.
- *
- * @ingroup jobs
  */
 enum job_requeue_t {
 
@@ -58,20 +56,18 @@ enum job_requeue_t {
 };
 
 /**
- * @brief The callback function to use for the callback job.
+ * The callback function to use for the callback job.
  *
  * This is the function to use as callback for a callback job. It receives
  * a parameter supplied to the callback jobs constructor.
  *
  * @param data			param supplied to job
  * @return				requeing policy how to requeue the job
- *
- * @ingroup jobs
  */
 typedef job_requeue_t (*callback_job_cb_t)(void *data);
 
 /**
- * @brief Cleanup function to use for data cleanup.
+ * Cleanup function to use for data cleanup.
  *
  * The callback has an optional user argument which receives data. However,
  * this data may be cleaned up if it is allocated. This is the function
@@ -79,22 +75,15 @@ typedef job_requeue_t (*callback_job_cb_t)(void *data);
  *
  * @param data			param supplied to job
  * @return				requeing policy how to requeue the job
- *
- * @ingroup jobs
  */
 typedef void (*callback_job_cleanup_t)(void *data);
 
 /**
- * @brief Class representing an callback Job.
+ * Class representing an callback Job.
  *
  * This is a special job which allows a simple callback function to
  * be executed by a thread of the thread pool. This allows simple execution
  * of asynchronous methods, without to manage threads.
- *
- * @b Constructors:
- * - callback_job_create()
- *
- * @ingroup jobs
  */
 struct callback_job_t {
 	/**
@@ -103,15 +92,13 @@ struct callback_job_t {
 	job_t job_interface;
 	
 	/**
-	 * @brief Cancel the jobs thread and wait for its termination.
-	 *
-	 * @param this		calling object
+	 * Cancel the jobs thread and wait for its termination.
 	 */
 	void (*cancel)(callback_job_t *this);
 };
 
 /**
- * @brief Creates a callback job.
+ * Creates a callback job.
  *
  * The cleanup function is called when the job gets destroyed to destroy
  * the associated data.
@@ -124,12 +111,9 @@ struct callback_job_t {
  * @param cleanup			destructor for data on destruction, or NULL
  * @param parent			parent of this job
  * @return					callback_job_t object
- * 
- * @ingroup jobs
  */
 callback_job_t *callback_job_create(callback_job_cb_t cb, void *data,
 									callback_job_cleanup_t cleanup,
 									callback_job_t *parent);
 
-#endif /* CALLBACK_JOB_H_ */
-
+#endif /* CALLBACK_JOB_H_ @} */

src/charon/processing/jobs/delete_child_sa_job.c

@@ -1,10 +1,3 @@
-/**
- * @file delete_child_sa_job.c
- *
- * @brief Implementation of delete_child_sa_job_t.
- *
- */
-
 /*
  * Copyright (C) 2006 Martin Willi
  * Hochschule fuer Technik Rapperswil
@@ -18,6 +11,8 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
 
 #include "delete_child_sa_job.h"

src/charon/processing/jobs/delete_child_sa_job.h

@@ -1,10 +1,3 @@
-/**
- * @file delete_child_sa_job.h
- * 
- * @brief Interface of delete_child_sa_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2006 Martin Willi
  * Hochschule fuer Technik Rapperswil
@@ -18,6 +11,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup delete_child_sa_job delete_child_sa_job
+ * @{ @ingroup jobs
  */
 
 #ifndef DELETE_CHILD_SA_JOB_H_
@@ -32,14 +32,9 @@ typedef struct delete_child_sa_job_t delete_child_sa_job_t;
 
 
 /**
- * @brief Class representing an DELETE_CHILD_SA Job.
+ * Class representing an DELETE_CHILD_SA Job.
  * 
  * This job initiates the delete of a CHILD SA.
- * 
- * @b Constructors:
- *  - delete_child_sa_job_create()
- * 
- * @ingroup jobs
  */
 struct delete_child_sa_job_t {
 	/**
@@ -49,7 +44,7 @@ struct delete_child_sa_job_t {
 };
 
 /**
- * @brief Creates a job of type DELETE_CHILD_SA.
+ * Creates a job of type DELETE_CHILD_SA.
  *
  * The CHILD_SA is identified by its reqid, protocol (AH/ESP) and its
  * inbound SPI.
@@ -58,11 +53,9 @@ struct delete_child_sa_job_t {
  * @param protocol	protocol of the CHILD_SA
  * @param spi		security parameter index of the CHILD_SA
  * @return			delete_child_sa_job_t object
- * 
- * @ingroup jobs
  */
 delete_child_sa_job_t *delete_child_sa_job_create(u_int32_t reqid, 
 												  protocol_id_t protocol, 
 												  u_int32_t spi);
 
-#endif /* DELETE_CHILD_SA_JOB_H_ */
+#endif /* DELETE_CHILD_SA_JOB_H_ @} */

src/charon/processing/jobs/delete_ike_sa_job.c

@@ -1,10 +1,3 @@
-/**
- * @file delete_ike_sa_job.c
- * 
- * @brief Implementation of delete_ike_sa_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2005-2006 Martin Willi
  * Copyright (C) 2005 Jan Hutter
@@ -19,6 +12,8 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
 
 #include "delete_ike_sa_job.h"

src/charon/processing/jobs/delete_ike_sa_job.h

@@ -1,10 +1,3 @@
-/**
- * @file delete_ike_sa_job.h
- * 
- * @brief Interface of delete_ike_sa_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2005-2006 Martin Willi
  * Copyright (C) 2005 Jan Hutter
@@ -19,6 +12,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup delete_child_sa_job delete_child_sa_job
+ * @{ @ingroup jobs
  */
  
 #ifndef DELETE_IKE_SA_JOB_H_
@@ -32,16 +32,11 @@ typedef struct delete_ike_sa_job_t delete_ike_sa_job_t;
 
 
 /**
- * @brief Class representing an DELETE_IKE_SA Job.
+ * Class representing an DELETE_IKE_SA Job.
  *
  * This job is responsible for deleting established or half open IKE_SAs. 
  * A half open IKE_SA is every IKE_SA which hasn't reache the SA_ESTABLISHED
  * state.
- *
- * @b Constructors:
- *  - delete_ike_sa_job_create()
- *
- * @ingroup jobs
  */
 struct delete_ike_sa_job_t {
 	
@@ -52,15 +47,13 @@ struct delete_ike_sa_job_t {
 };
 
 /**
- * @brief Creates a job of type DELETE_IKE_SA.
+ * Creates a job of type DELETE_IKE_SA.
  * 
  * @param ike_sa_id				id of the IKE_SA to delete
  * @param delete_if_established	should the IKE_SA be deleted if it is established?
  * @return						created delete_ike_sa_job_t object
- * 
- * @ingroup jobs
  */
 delete_ike_sa_job_t *delete_ike_sa_job_create(ike_sa_id_t *ike_sa_id,
 											  bool delete_if_established);
 
-#endif /* DELETE_IKE_SA_JOB_H_ */
+#endif /* DELETE_IKE_SA_JOB_H_ @} */

src/charon/processing/jobs/initiate_mediation_job.c

@@ -1,10 +1,3 @@
-/**
- * @file initiate_mediation_job.c
- * 
- * @brief Implementation of initiate_mediation_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2007 Tobias Brunner
  * Hochschule fuer Technik Rapperswil
@@ -18,9 +11,10 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
 
-
 #include "initiate_mediation_job.h"
 
 #include <sa/ike_sa.h>

src/charon/processing/jobs/initiate_mediation_job.h

@@ -1,9 +1,3 @@
-/**
- * @file initiate_mediation_job.h
- * 
- * @brief Interface of initiate_mediation_job_t.
- */
-
 /*
  * Copyright (C) 2007 Tobias Brunner
  * Hochschule fuer Technik Rapperswil
@@ -17,6 +11,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup initiate_mediation_job initiate_mediation_job
+ * @{ @ingroup jobs
  */
 
 #ifndef INITIATE_MEDIATION_JOB_H_
@@ -29,15 +30,10 @@ typedef struct initiate_mediation_job_t initiate_mediation_job_t;
 #include <sa/ike_sa_id.h>
 
 /**
- * @brief Class representing a INITIATE_MEDIATION Job.
+ * Class representing a INITIATE_MEDIATION Job.
  * 
  * This job will initiate a mediation on behalf of a mediated connection.
  * If required the mediation connection is established.
- * 
- * @b Constructors:
- * - initiate_mediation_job_create()
- * 
- * @ingroup jobs
  */
 struct initiate_mediation_job_t {
 	/**
@@ -47,28 +43,24 @@ struct initiate_mediation_job_t {
 };
 
 /**
- * @brief Creates a job of type INITIATE_MEDIATION.
+ * Creates a job of type INITIATE_MEDIATION.
  * 
  * @param ike_sa_id		identification of the ike_sa as ike_sa_id_t object (gets cloned)
  * @param child_cfg		child config of the child_sa (gets cloned)
  * @return				job object
- * 
- * @ingroup jobs
  */
 initiate_mediation_job_t *initiate_mediation_job_create(ike_sa_id_t *ike_sa_id,
 		child_cfg_t *child_cfg);
 
 /**
- * @brief Creates a special job of type INITIATE_MEDIATION that reinitiates a
+ * Creates a special job of type INITIATE_MEDIATION that reinitiates a
  * specific connection.
  * 
  * @param mediation_sa_id		identification of the mediation sa (gets cloned)
  * @param mediated_sa_id		identification of the mediated sa (gets cloned)
  * @return						job object
- * 
- * @ingroup jobs
  */
 initiate_mediation_job_t *reinitiate_mediation_job_create(ike_sa_id_t *mediation_sa_id,
 		ike_sa_id_t *mediated_sa_id);
 
-#endif /*INITIATE_MEDIATION_JOB_H_*/
+#endif /*INITIATE_MEDIATION_JOB_H_ @} */

src/charon/processing/jobs/job.h

@@ -1,10 +1,3 @@
-/**
- * @file job.h
- * 
- * @brief Interface job_t.
- * 
- */
-
 /*
  * Copyright (C) 2005-2006 Martin Willi
  * Copyright (C) 2005 Jan Hutter
@@ -19,6 +12,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup job job
+ * @{ @ingroup jobs
  */
 
 #ifndef JOB_H_
@@ -28,38 +28,27 @@ typedef struct job_t job_t;
 
 #include <library.h>
 
-
 /**
- * @brief Job-Interface as it is stored in the job queue.
- * 
- * @b Constructors:
- * - None, use specific implementation of the interface.
- * 
- * @ingroup jobs
+ * Job-Interface as it is stored in the job queue.
  */
 struct job_t {
 
 	/**
-	 * @brief Execute a job.
+	 * Execute a job.
 	 * 
 	 * The processing facility executes a job using this method. Jobs are
 	 * one-shot, they destroy themself after execution, so don't use a job
 	 * once it has been executed.
-	 *
-	 * @param this 				calling object
 	 */
 	void (*execute) (job_t *this);
 
 	/**
-	 * @brief Destroy a job.
+	 * Destroy a job.
 	 *
 	 * Is only called whenever a job was not executed (e.g. due daemon shutdown).
 	 * After execution, jobs destroy themself.
-	 * 
-	 * @param job_t calling object
 	 */
 	void (*destroy) (job_t *job);
 };
 
-#endif /* JOB_H_ */
-
+#endif /* JOB_H_ @} */

src/charon/processing/jobs/mediation_job.c

@@ -1,10 +1,3 @@
-/**
- * @file mediation_job.c
- * 
- * @brief Implementation of mediation_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2007 Tobias Brunner
  * Hochschule fuer Technik Rapperswil
@@ -18,9 +11,10 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
 
-
 #include "mediation_job.h"
 
 #include <encoding/payloads/endpoint_notify.h>

src/charon/processing/jobs/mediation_job.h

@@ -1,9 +1,3 @@
-/**
- * @file mediation_job.h
- * 
- * @brief Interface of mediation_job_t.
- */
-
 /*
  * Copyright (C) 2007 Tobias Brunner
  * Hochschule fuer Technik Rapperswil
@@ -17,6 +11,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup mediation_job mediation_job
+ * @{ @ingroup jobs
  */
 
 #ifndef MEDIATION_JOB_H_
@@ -30,14 +31,9 @@ typedef struct mediation_job_t mediation_job_t;
 #include <utils/linked_list.h>
 
 /**
- * @brief Class representing a MEDIATION Job.
+ * Class representing a MEDIATION Job.
  * 
  * This job handles the mediation on the mediation server.
- * 
- * @b Constructors:
- * - mediation_job_create()
- * 
- * @ingroup jobs
  */
 struct mediation_job_t {
 	/**
@@ -47,7 +43,7 @@ struct mediation_job_t {
 };
 
 /**
- * @brief Creates a job of type MEDIATION.
+ * Creates a job of type MEDIATION.
  * 
  * Parameters get cloned.
  * 
@@ -58,8 +54,6 @@ struct mediation_job_t {
  * @param endpoints		list of submitted endpoints
  * @param response		TRUE if this is a response
  * @return				job object
- * 
- * @ingroup jobs
  */
 mediation_job_t *mediation_job_create(identification_t *peer_id,
 		identification_t *requester, chunk_t session_id, chunk_t session_key,
@@ -67,7 +61,7 @@ mediation_job_t *mediation_job_create(identification_t *peer_id,
 
 
 /**
- * @brief Creates a special job of type MEDIATION that is used to send a callback
+ * Creates a special job of type MEDIATION that is used to send a callback
  * notification to a peer.
  * 
  * Parameters get cloned.
@@ -75,10 +69,8 @@ mediation_job_t *mediation_job_create(identification_t *peer_id,
  * @param requester		ID of the waiting peer
  * @param peer_id		ID of the requested peer
  * @return				job object
- * 
- * @ingroup jobs
  */
 mediation_job_t *mediation_callback_job_create(identification_t *requester,
 		identification_t *peer_id);
 
-#endif /*MEDIATION_JOB_H_*/
+#endif /*MEDIATION_JOB_H_ @} */

src/charon/processing/jobs/process_message_job.c

@@ -1,10 +1,3 @@
-/**
- * @file process_message_job.h
- * 
- * @brief Implementation of process_message_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2005-2007 Martin Willi
  * Copyright (C) 2005 Jan Hutter
@@ -19,9 +12,10 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
 
-
 #include "process_message_job.h"
 
 #include <daemon.h>

src/charon/processing/jobs/process_message_job.h

@@ -1,10 +1,3 @@
-/**
- * @file process_message_job.h
- * 
- * @brief Interface of process_message_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2005-2007 Martin Willi
  * Copyright (C) 2005 Jan Hutter
@@ -19,6 +12,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup process_message_job process_message_job
+ * @{ @ingroup jobs
  */
 
 #ifndef PROCESS_MESSAGE_JOB_H_
@@ -31,12 +31,7 @@ typedef struct process_message_job_t process_message_job_t;
 #include <processing/jobs/job.h>
 
 /**
- * @brief Class representing an PROCESS_MESSAGE job.
- *
- * @b Constructors:
- * - process_message_job_create()
- *
- * @ingroup jobs
+ * Class representing an PROCESS_MESSAGE job.
  */
 struct process_message_job_t {
 	/**
@@ -46,13 +41,11 @@ struct process_message_job_t {
 };
 
 /**
- * @brief Creates a job of type PROCESS_MESSAGE.
+ * Creates a job of type PROCESS_MESSAGE.
  * 
  * @param message		message to process
  * @return				created process_message_job_t object
- * 
- * @ingroup jobs
  */
 process_message_job_t *process_message_job_create(message_t *message);
 
-#endif /*PROCESS_MESSAGE_JOB_H_*/
+#endif /*PROCESS_MESSAGE_JOB_H_ @} */

src/charon/processing/jobs/rekey_child_sa_job.c

@@ -1,10 +1,3 @@
-/**
- * @file rekey_child_sa_job.c
- * 
- * @brief Implementation of rekey_child_sa_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2006 Martin Willi
  * Hochschule fuer Technik Rapperswil
@@ -18,6 +11,8 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
 
 #include "rekey_child_sa_job.h"

src/charon/processing/jobs/rekey_child_sa_job.h

@@ -1,10 +1,3 @@
-/**
- * @file rekey_child_sa_job.h
- * 
- * @brief Interface of rekey_child_sa_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2006 Martin Willi
  * Hochschule fuer Technik Rapperswil
@@ -18,6 +11,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup rekey_child_sa_job rekey_child_sa_job
+ * @{ @ingroup jobs
  */
 
 #ifndef REKEY_CHILD_SA_JOB_H_
@@ -31,14 +31,9 @@ typedef struct rekey_child_sa_job_t rekey_child_sa_job_t;
 #include <config/proposal.h>
 
 /**
- * @brief Class representing an REKEY_CHILD_SA Job.
+ * Class representing an REKEY_CHILD_SA Job.
  *
  * This job initiates the rekeying of a CHILD SA.
- *
- * @b Constructors:
- *  - rekey_child_sa_job_create()
- *
- * @ingroup jobs
  */
 struct rekey_child_sa_job_t {
 	/**
@@ -48,7 +43,7 @@ struct rekey_child_sa_job_t {
 };
 
 /**
- * @brief Creates a job of type REKEY_CHILD_SA.
+ * Creates a job of type REKEY_CHILD_SA.
  *
  * The CHILD_SA is identified by its protocol (AH/ESP) and its
  * inbound SPI.
@@ -57,9 +52,8 @@ struct rekey_child_sa_job_t {
  * @param protocol	protocol of the CHILD_SA
  * @param spi		security parameter index of the CHILD_SA
  * @return			rekey_child_sa_job_t object
- * 
- * @ingroup jobs
  */
-rekey_child_sa_job_t *rekey_child_sa_job_create(u_int32_t reqid, protocol_id_t protocol, u_int32_t spi);
-
-#endif /* REKEY_CHILD_SA_JOB_H_ */
+rekey_child_sa_job_t *rekey_child_sa_job_create(u_int32_t reqid, 
+												protocol_id_t protocol,
+												u_int32_t spi);
+#endif /* REKEY_CHILD_SA_JOB_H_ @} */

src/charon/processing/jobs/rekey_ike_sa_job.c

@@ -1,10 +1,3 @@
-/**
- * @file rekey_ike_sa_job.c
- * 
- * @brief Implementation of rekey_ike_sa_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2006 Martin Willi
  * Hochschule fuer Technik Rapperswil
@@ -18,13 +11,14 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
-
+ 
 #include "rekey_ike_sa_job.h"
 
 #include <daemon.h>
 
-
 typedef struct private_rekey_ike_sa_job_t private_rekey_ike_sa_job_t;
 
 /**

src/charon/processing/jobs/rekey_ike_sa_job.h

@@ -1,10 +1,3 @@
-/**
- * @file rekey_ike_sa_job.h
- * 
- * @brief Interface of rekey_ike_sa_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2006 Martin Willi
  * Hochschule fuer Technik Rapperswil
@@ -18,6 +11,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup rekey_ike_sa_job rekey_ike_sa_job
+ * @{ @ingroup jobs
  */
 
 #ifndef REKEY_IKE_SA_JOB_H_
@@ -30,14 +30,9 @@ typedef struct rekey_ike_sa_job_t rekey_ike_sa_job_t;
 #include <processing/jobs/job.h>
 
 /**
- * @brief Class representing an REKEY_IKE_SA Job.
+ * Class representing an REKEY_IKE_SA Job.
  * 
  * This job initiates the rekeying of an IKE_SA.
- * 
- * @b Constructors:
- *  - rekey_ike_sa_job_create()
- * 
- * @ingroup jobs
  */
 struct rekey_ike_sa_job_t {
 	/**
@@ -47,14 +42,12 @@ struct rekey_ike_sa_job_t {
 };
 
 /**
- * @brief Creates a job of type REKEY_IKE_SA.
+ * Creates a job of type REKEY_IKE_SA.
  *
  * @param ike_sa_id		ID of the IKE_SA to rekey
  * @param reauth		TRUE to reauthenticate peer, FALSE for rekeying only
  * @return				rekey_ike_sa_job_t object
- * 
- * @ingroup jobs
  */
 rekey_ike_sa_job_t *rekey_ike_sa_job_create(ike_sa_id_t *ike_sa_id, bool reauth);
 
-#endif /* REKEY_IKE_SA_JOB_H_ */
+#endif /* REKEY_IKE_SA_JOB_H_ @} */

src/charon/processing/jobs/retransmit_job.c

@@ -1,10 +1,3 @@
-/**
- * @file retransmit_job.c
- * 
- * @brief Implementation of retransmit_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2005-2007 Martin Willi
  * Copyright (C) 2005 Jan Hutter
@@ -19,6 +12,8 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
  
 #include "retransmit_job.h"

src/charon/processing/jobs/retransmit_job.h

@@ -1,10 +1,3 @@
-/**
- * @file retransmit_job.h
- * 
- * @brief Interface of retransmit_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2005-2007 Martin Willi
  * Copyright (C) 2005 Jan Hutter
@@ -19,6 +12,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup retransmit_job retransmit_job
+ * @{ @ingroup jobs
  */
 
 #ifndef RETRANSMIT_JOB_H_
@@ -31,16 +31,11 @@ typedef struct retransmit_job_t retransmit_job_t;
 #include <sa/ike_sa_id.h>
 
 /**
- * @brief Class representing an retransmit Job.
+ * Class representing an retransmit 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_job_create()
- *
- * @ingroup jobs
  */
 struct retransmit_job_t {
 	/**
@@ -50,15 +45,13 @@ struct retransmit_job_t {
 };
 
 /**
- * @brief Creates a job of type retransmit.
+ * Creates a job of type retransmit.
  * 
  * @param message_id		message_id of the request to resend
  * @param ike_sa_id			identification of the ike_sa as ike_sa_id_t
  * @return					retransmit_job_t object
- * 
- * @ingroup jobs
  */
 retransmit_job_t *retransmit_job_create(u_int32_t message_id,
 										ike_sa_id_t *ike_sa_id);
 
-#endif /* RETRANSMIT_JOB_H_ */
+#endif /* RETRANSMIT_JOB_H_ @} */

src/charon/processing/jobs/roam_job.c

@@ -1,10 +1,3 @@
-/**
- * @file roam_job.c
- * 
- * @brief Implementation of roam_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2007 Martin Willi
  * Hochschule fuer Technik Rapperswil
@@ -18,9 +11,10 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
 
-
 #include <stdlib.h>
 
 #include "roam_job.h"

src/charon/processing/jobs/roam_job.h

@@ -1,9 +1,3 @@
-/**
- * @file roam_job.h
- * 
- * @brief Interface of roam_job_t.
- */
-
 /*
  * Copyright (C) 2007 Martin Willi
  * Hochschule fuer Technik Rapperswil
@@ -17,6 +11,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup roam_job roam_job
+ * @{ @ingroup jobs
  */
 
 #ifndef ROAM_JOB_H_
@@ -29,15 +30,10 @@ typedef struct roam_job_t roam_job_t;
 #include <processing/jobs/job.h>
 
 /**
- * @brief A job to inform IKE_SAs about changed local address setup.
+ * A job to inform IKE_SAs about changed local address setup.
  * 
  * If a local address appears or disappears, the kernel fires this job to
  * update all IKE_SAs.
- * 
- * @b Constructors:
- * - roam_job_create()
- * 
- * @ingroup jobs
  */
 struct roam_job_t {
 
@@ -48,14 +44,11 @@ struct roam_job_t {
 };
 
 /**
- * @brief Creates a job to inform IKE_SAs about an updated address list.
+ * Creates a job to inform IKE_SAs about an updated address list.
  * 
  * @param address		TRUE if address list changed, FALSE if routing changed
  * @return				initiate_ike_sa_job_t object
- * 
- * @ingroup jobs
  */
 roam_job_t *roam_job_create(bool address);
 
-#endif /*ROAM_JOB_H_*/
-
+#endif /*ROAM_JOB_H_ @} */

src/charon/processing/jobs/send_dpd_job.c

@@ -1,10 +1,3 @@
-/**
- * @file send_dpd_job.c
- * 
- * @brief Implementation of send_dpd_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2006 Tobias Brunner, Daniel Roethlisberger
  * Hochschule fuer Technik Rapperswil
@@ -18,9 +11,10 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
 
-
 #include <stdlib.h>
 
 #include "send_dpd_job.h"

src/charon/processing/jobs/send_dpd_job.h

@@ -1,9 +1,3 @@
-/**
- * @file send_dpd_job.h
- * 
- * @brief Interface of send_dpd_job_t.
- */
-
 /*
  * Copyright (C) 2006 Tobias Brunner, Daniel Roethlisberger
  * Hochschule fuer Technik Rapperswil
@@ -17,6 +11,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup send_dpd_job send_dpd_job
+ * @{ @ingroup jobs
  */
 
 #ifndef SEND_DPD_JOB_H_
@@ -29,16 +30,11 @@ typedef struct send_dpd_job_t send_dpd_job_t;
 #include <sa/ike_sa_id.h>
 
 /**
- * @brief Class representing a SEND_DPD Job.
+ * Class representing a SEND_DPD Job.
  * 
  * Job to periodically send a Dead Peer Detection (DPD) request,
  * ie. an IKE request with no payloads other than the encrypted payload
  * required by the syntax.
- * 
- * @b Constructors:
- * - send_dpd_job_create()
- * 
- * @ingroup jobs
  */
 struct send_dpd_job_t {
 	/**
@@ -48,13 +44,11 @@ struct send_dpd_job_t {
 };
 
 /**
- * @brief Creates a job of type SEND_DPD.
+ * Creates a job of type SEND_DPD.
  * 
  * @param ike_sa_id		identification of the ike_sa as ike_sa_id_t object (gets cloned)
  * @return				initiate_ike_sa_job_t object
- * 
- * @ingroup jobs
  */
 send_dpd_job_t *send_dpd_job_create(ike_sa_id_t *ike_sa_id);
 
-#endif /*SEND_DPD_JOB_H_*/
+#endif /*SEND_DPD_JOB_H_ @} */

src/charon/processing/jobs/send_keepalive_job.c

@@ -1,10 +1,3 @@
-/**
- * @file send_keepalive_job.c
- * 
- * @brief Implementation of send_keepalive_job_t.
- * 
- */
-
 /*
  * Copyright (C) 2006 Tobias Brunner, Daniel Roethlisberger
  * Hochschule fuer Technik Rapperswil
@@ -18,9 +11,10 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
 
-
 #include <stdlib.h>
 
 #include "send_keepalive_job.h"

src/charon/processing/jobs/send_keepalive_job.h

@@ -1,9 +1,3 @@
-/**
- * @file send_keepalive_job.h
- * 
- * @brief Interface of send_keepalive_job_t.
- */
-
 /*
  * Copyright (C) 2006 Tobias Brunner, Daniel Roethlisberger
  * Hochschule fuer Technik Rapperswil
@@ -17,6 +11,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup send_keepalive_job send_keepalive_job
+ * @{ @ingroup jobs
  */
 
 #ifndef SEND_KEEPALIVE_JOB_H_
@@ -29,15 +30,10 @@ typedef struct send_keepalive_job_t send_keepalive_job_t;
 #include <sa/ike_sa_id.h>
 
 /**
- * @brief Class representing a SEND_KEEPALIVE Job.
+ * Class representing a SEND_KEEPALIVE Job.
  * 
  * This job will send a NAT keepalive packet if the IKE SA is still alive,
  * and reinsert itself into the event queue.
- * 
- * @b Constructors:
- * - send_keepalive_job_create()
- * 
- * @ingroup jobs
  */
 struct send_keepalive_job_t {
 	/**
@@ -47,13 +43,11 @@ struct send_keepalive_job_t {
 };
 
 /**
- * @brief Creates a job of type SEND_KEEPALIVE.
+ * Creates a job of type SEND_KEEPALIVE.
  * 
  * @param ike_sa_id		identification of the ike_sa as ike_sa_id_t object (gets cloned)
  * @return				initiate_ike_sa_job_t object
- * 
- * @ingroup jobs
  */
 send_keepalive_job_t *send_keepalive_job_create(ike_sa_id_t *ike_sa_id);
 
-#endif /*SEND_KEEPALIVE_JOB_H_*/
+#endif /*SEND_KEEPALIVE_JOB_H_ @} */

src/charon/processing/processor.c

@@ -1,10 +1,3 @@
-/**
- * @file processor.c
- *
- * @brief Implementation of processor_t.
- *
- */
-
 /*
  * Copyright (C) 2005-2007 Martin Willi
  * Copyright (C) 2005 Jan Hutter
@@ -19,6 +12,8 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
  
 #include <stdlib.h>
@@ -35,7 +30,7 @@
 typedef struct private_processor_t private_processor_t;
 
 /**
- * @brief Private data of processor_t class.
+ * Private data of processor_t class.
  */
 struct private_processor_t {
 	/**

src/charon/processing/processor.h

@@ -1,10 +1,3 @@
-/**
- * @file processor.h
- * 
- * @brief Interface of processor_t.
- * 
- */
-
 /*
  * Copyright (C) 2005-2007 Martin Willi
  * Copyright (C) 2005 Jan Hutter
@@ -19,6 +12,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup processor processor
+ * @{ @ingroup processing
  */
 
 #ifndef PROCESSOR_H_
@@ -32,80 +32,65 @@ typedef struct processor_t processor_t;
 #include <processing/jobs/job.h>
 
 /**
- * @brief The processor uses threads to process queued jobs.
- *
- * @b Constructors:
- *  - processor_create()
- * 
- * @ingroup processing
+ * The processor uses threads to process queued jobs.
  */
 struct processor_t {
 	
 	/**
-	 * @brief Get the total number of threads used by the processor.
-	 *
-	 * @param this			calling object		
+	 * Get the total number of threads used by the processor.
+	 *	
 	 * @return				size of thread pool
 	 */
 	u_int (*get_total_threads) (processor_t *this);
 	
 	/**
-	 * @brief Get the number of threads currently waiting.
-	 *
-	 * @param this			calling object		
+	 * Get the number of threads currently waiting.
+	 *	
 	 * @return				number of idle threads
 	 */
 	u_int (*get_idle_threads) (processor_t *this);
 	
 	/**
-	 * @brief Get the number of queued jobs.
+	 * Get the number of queued jobs.
 	 *
-	 * @param this			calling object
 	 * @returns 			number of items in queue
 	 */
 	u_int (*get_job_load) (processor_t *this);
 
 	/**
-	 * @brief Adds a job to the queue.
+	 * Adds a job to the queue.
 	 *
 	 * This function is non blocking and adds a job_t to the queue.
 	 *
-	 * @param this		 	calling object
  	 * @param job 			job to add to the queue
 	 */
 	void (*queue_job) (processor_t *this, job_t *job);
 	
 	/**
-	 * @brief Set the number of threads to use in the processor.
+	 * Set the number of threads to use in the processor.
 	 *
 	 * If the number of threads is smaller than number of currently running
 	 * threads, thread count is decreased. Use 0 to disable the processor.
 	 * This call blocks if it decreases thread count until threads have
 	 * terminated, so make sure there are not too many blocking jobs.
 	 *
-	 * @param this			calling object
 	 * @param count			number of threads to allocate
 	 */
 	void (*set_threads)(processor_t *this, u_int count);
 	
 	/**
-	 * @brief Destroy a processor object.
-	 * 
-	 * @param processor	calling object
+	 * Destroy a processor object.
 	 */
 	void (*destroy) (processor_t *processor);
 };
 
 /**
- * @brief Create the thread pool without any threads.
+ * Create the thread pool without any threads.
  *
  * Use the set_threads method to start processing jobs.
  *
  * @return					processor_t object
- *
- * @ingroup processing
  */
 processor_t *processor_create();
 
-#endif /*PROCESSOR_H_*/
-
+#endif /*PROCESSOR_H_ @} */

src/charon/processing/scheduler.c

@@ -1,10 +1,3 @@
-/**
- * @file scheduler.c
- *
- * @brief Implementation of scheduler_t.
- *
- */
-
 /*
  * Copyright (C) 2005-2006 Martin Willi
  * Copyright (C) 2005 Jan Hutter
@@ -19,6 +12,8 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
  */
 
 #include <stdlib.h>

src/charon/processing/scheduler.h

@@ -1,10 +1,3 @@
-/**
- * @file scheduler.h
- * 
- * @brief Interface of scheduler_t.
- * 
- */
-
 /*
  * Copyright (C) 2005-2007 Martin Willi
  * Copyright (C) 2005 Jan Hutter
@@ -19,6 +12,13 @@
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * for more details.
+ *
+ * $Id$
+ */
+
+/**
+ * @defgroup scheduler scheduler
+ * @{ @ingroup processing
  */
 
 #ifndef SCHEDULER_H_
@@ -30,52 +30,40 @@ typedef struct scheduler_t scheduler_t;
 #include <processing/jobs/job.h>
 
 /**
- * @brief The scheduler queues and executes timed events.
+ * The scheduler queues and executes timed events.
  *
  * The scheduler stores timed events and passes them to the processor.
- *
- * @b Constructors:
- *  - scheduler_create()
- *
- * @ingroup processing
  */
 struct scheduler_t { 	
 
 	/**
-	 * @brief Adds a event to the queue, using a relative time offset.
+	 * Adds a event to the queue, using a relative time offset.
 	 *
 	 * Schedules a job for execution using a relative time offset.
 	 *
-	 * @param this			calling object
  	 * @param job 			job to schedule
   	 * @param time 			relative to to schedule job (in ms)
 	 */
 	void (*schedule_job) (scheduler_t *this, job_t *job, u_int32_t time);
 	
 	/**
-	 * @brief Returns number of jobs scheduled.
+	 * Returns number of jobs scheduled.
 	 *
-	 * @param this			calling object
 	 * @return 				number of scheduled jobs
 	 */
 	u_int (*get_job_load) (scheduler_t *this);
 	
 	/**
-	 * @brief Destroys a scheduler object.
-	 * 
-	 * @param this		 	calling object
+	 * Destroys a scheduler object.
 	 */
 	void (*destroy) (scheduler_t *this);
 };
 
 /**
- * @brief Create a scheduler.
+ * Create a scheduler.
  * 
  * @return 		scheduler_t object
- * 
- * @ingroup processing
  */
 scheduler_t *scheduler_create(void);
 
-#endif /*SCHEDULER_H_*/
-
+#endif /*SCHEDULER_H_ @} */