merged the modularization branch (credentials) back to trunk

src/charon/sa/tasks/ike_p2p.h

@@ -1,10 +1,3 @@
-/**
- * @file ike_p2p.h
- * 
- * @brief Interface ike_p2p_t.
- * 
- */
-
 /*
  * Copyright (C) 2007 Tobias Brunner
  * 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 ike_p2p ike_p2p
+ * @{ @ingroup tasks
  */
 
 #ifndef IKE_P2P_H_
@@ -30,7 +30,7 @@ typedef struct ike_p2p_t ike_p2p_t;
 #include <sa/tasks/task.h>
 
 /**
- * @brief Task of type IKE_P2P, detects and handles P2P-NAT-T extensions.
+ * Task of type IKE_P2P, detects and handles P2P-NAT-T extensions.
  *
  * This tasks handles the P2P_MEDIATION notify exchange to setup a mediation
  * connection, allows to initiate mediated connections using P2P_CONNECT
@@ -40,11 +40,6 @@ typedef struct ike_p2p_t ike_p2p_t;
  * @note This task has to be activated before the IKE_AUTH task, because that
  * task generates the IKE_SA_INIT message so that no more payloads can be added
  * to it afterwards.
- *
- * @b Constructors:
- *  - ike_p2p_create()
- * 
- * @ingroup tasks
  */
 struct ike_p2p_t {
 
@@ -54,38 +49,34 @@ struct ike_p2p_t {
 	task_t task;
 	
 	/**
-	 * @brief Initiates a connection with another peer (i.e. sends a P2P_CONNECT
+	 * Initiates a connection with another peer (i.e. sends a P2P_CONNECT
 	 * to the mediation server)
 	 *
-	 * @param this				object
 	 * @param peer_id			ID of the other peer (gets cloned)
 	 */
 	void (*connect)(ike_p2p_t *this, identification_t *peer_id);
 	
 	/**
-	 * @brief Responds to a P2P_CONNECT from another peer (i.e. sends a P2P_CONNECT
+	 * Responds to a P2P_CONNECT from another peer (i.e. sends a P2P_CONNECT
 	 * to the mediation server)
 	 * 
-	 * @param this				object
 	 * @param peer_id			ID of the other peer (gets cloned)
 	 * @param session_id		the session ID as provided by the initiator (gets cloned)
 	 */
 	void (*respond)(ike_p2p_t *this, identification_t *peer_id, chunk_t session_id);
 	
 	/**
-	 * @brief Sends a P2P_CALLBACK to a peer that previously requested another peer.
+	 * Sends a P2P_CALLBACK to a peer that previously requested another peer.
 	 * 
-	 * @param this				object
 	 * @param peer_id			ID of the other peer (gets cloned)
 	 */
 	void (*callback)(ike_p2p_t *this, identification_t *peer_id);
 	
 	/**
-	 * @brief Relays data to another peer (i.e. sends a P2P_CONNECT to the peer)
+	 * Relays data to another peer (i.e. sends a P2P_CONNECT to the peer)
 	 * 
 	 * Data gets cloned.
 	 * 
-	 * @param this				object
 	 * @param requester			ID of the requesting peer
 	 * @param session_id		content of the P2P_SESSIONID notify
 	 * @param session_key		content of the P2P_SESSIONKEY notify
@@ -98,7 +89,7 @@ struct ike_p2p_t {
 };
 
 /**
- * @brief Create a new ike_p2p task.
+ * Create a new ike_p2p task.
  *
  * @param ike_sa		IKE_SA this task works for
  * @param initiator		TRUE if taks is initiated by us
@@ -106,5 +97,4 @@ struct ike_p2p_t {
  */
 ike_p2p_t *ike_p2p_create(ike_sa_t *ike_sa, bool initiator);
 
-
-#endif /*IKE_P2P_H_*/
+#endif /*IKE_P2P_H_ @} */