merged the modularization branch (credentials) back to trunk

src/charon/encoding/payloads/ike_header.h

@@ -1,10 +1,3 @@
-/**
- * @file ike_header.h
- * 
- * @brief Interface of ike_header_t. 
- * 
- */
-
 /*
  * Copyright (C) 2007 Tobias Brunner
  * Copyright (C) 2005-2006 Martin Willi
@@ -20,6 +13,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_header ike_header
+ * @{ @ingroup payloads
  */
 
 #ifndef IKE_HEADER_H_
@@ -33,38 +33,28 @@ typedef struct ike_header_t ike_header_t;
 
 /**
  * Major Version of IKEv2.
- * 
- * @ingroup payloads
  */
 #define IKE_MAJOR_VERSION 2
 
 /**
  * Minor Version of IKEv2.
- * 
- * @ingroup payloads
  */
 #define IKE_MINOR_VERSION 0
 
 /**
  * Flag in IKEv2-Header. Always 0.
- * 
- * @ingroup payloads
  */
 #define HIGHER_VERSION_SUPPORTED_FLAG 0
 
 /**
  * Length of IKE Header in Bytes.
- * 
- * @ingroup payloads
  */
 #define IKE_HEADER_LENGTH 28
 
 /**
- * @brief Different types of IKE-Exchanges.
+ * Different types of IKE-Exchanges.
  *
- * See Draft for different types.
- * 
- * @ingroup payloads
+ * See RFC for different types.
  */
 enum exchange_type_t{
 
@@ -102,23 +92,16 @@ enum exchange_type_t{
 
 /**
  * enum name for exchange_type_t
- * 
- * @ingroup payloads
  */
 extern enum_name_t *exchange_type_names;
 
 /**
- * @brief An object of this type represents an IKEv2 header and is used to 
+ * An object of this type represents an IKEv2 header and is used to 
  * generate and parse IKEv2 headers.
  * 
  * The header format of an IKEv2-Message is compatible to the 
  * ISAKMP-Header format to allow implementations supporting 
  * both versions of the IKE-protocol.
- * 
- * @b Constructors:
- * - ike_header_create()
- * 
- * @ingroup payloads
  */
 struct ike_header_t {
 	/**
@@ -127,141 +110,121 @@ struct ike_header_t {
 	payload_t payload_interface;
 	
 	/**
-	 * @brief Get the initiator spi.
+	 * Get the initiator spi.
 	 *
-	 * @param this 			ike_header_t object
 	 * @return 				initiator_spi
 	 */
 	u_int64_t (*get_initiator_spi) (ike_header_t *this);
 	
 	/**
-	 * @brief Set the initiator spi.
+	 * Set the initiator spi.
 	 *
-	 * @param this 			ike_header_t object
 	 * @param initiator_spi	initiator_spi
 	 */
 	void (*set_initiator_spi) (ike_header_t *this, u_int64_t initiator_spi);
 	
 	/**
-	 * @brief Get the responder spi.
+	 * Get the responder spi.
 	 *
-	 * @param this 			ike_header_t object
 	 * @return 				responder_spi
 	 */
 	u_int64_t (*get_responder_spi) (ike_header_t *this);
 	
 	/**
-	 * @brief Set the responder spi.
+	 * Set the responder spi.
 	 *
-	 * @param this 			ike_header_t object
 	 * @param responder_spi	responder_spi
 	 */
 	void (*set_responder_spi) (ike_header_t *this, u_int64_t responder_spi);
 	
 	/**
-	 * @brief Get the major version.
+	 * Get the major version.
 	 *
-	 * @param this 			ike_header_t object
 	 * @return 				major version
 	 */
 	u_int8_t (*get_maj_version) (ike_header_t *this);
 	
 	/**
-	 * @brief Get the minor version.
+	 * Get the minor version.
 	 *
-	 * @param this 			ike_header_t object
 	 * @return 				minor version
 	 */
 	u_int8_t (*get_min_version) (ike_header_t *this);
 	
 	/**
-	 * @brief Get the response flag.
+	 * Get the response flag.
 	 *
-	 * @param this 			ike_header_t object
 	 * @return 				response flag
 	 */
 	bool (*get_response_flag) (ike_header_t *this);
 	
 	/**
-	 * @brief Set the response flag-
+	 * Set the response flag-
 	 *
-	 * @param this 			ike_header_t object
 	 * @param response		response flag
 	 * 
 	 */
 	void (*set_response_flag) (ike_header_t *this, bool response);
 	/**
-	 * @brief Get "higher version supported"-flag.
+	 * Get "higher version supported"-flag.
 	 *
-	 * @param this 			ike_header_t object
 	 * @return 				version flag
 	 */
 	bool (*get_version_flag) (ike_header_t *this);
 	
 	/**
-	 * @brief Get the initiator flag.
+	 * Get the initiator flag.
 	 *
-	 * @param this 			ike_header_t object
 	 * @return 				initiator flag
 	 */
 	bool (*get_initiator_flag) (ike_header_t *this);
 	
 	/**
-	 * @brief Set the initiator flag.
+	 * Set the initiator flag.
 	 *
-	 * @param this 			ike_header_t object
 	 * @param initiator		initiator flag
-	 * 
 	 */
 	void (*set_initiator_flag) (ike_header_t *this, bool initiator);
 
 	/**
-	 * @brief Get the exchange type.
+	 * Get the exchange type.
 	 *
-	 * @param this 			ike_header_t object
-	 * @return 				 exchange type
+	 * @return 				exchange type
 	 */
 	u_int8_t (*get_exchange_type) (ike_header_t *this);
 	
 	/**
-	 * @brief Set the  exchange type.
+	 * Set the  exchange type.
 	 *
-	 * @param this 			ike_header_t object
 	 * @param exchange_type	exchange type
 	 */
 	void (*set_exchange_type) (ike_header_t *this, u_int8_t exchange_type);
 	
 	/**
-	 * @brief Get the message id.
+	 * Get the message id.
 	 *
-	 * @param this 			ike_header_t object
 	 * @return 				message id
 	 */
 	u_int32_t (*get_message_id) (ike_header_t *this);
 	
 	/**
-	 * @brief Set the message id.
+	 * Set the message id.
 	 *
-	 * @param this 			ike_header_t object
 	 * @param initiator_spi	message id
 	 */
 	void (*set_message_id) (ike_header_t *this, u_int32_t message_id);
 	
 	/**
-	 * @brief Destroys a ike_header_t object.
-	 *
-	 * @param this 			ike_header_t object to destroy
+	 * Destroys a ike_header_t object.
 	 */
 	void (*destroy) (ike_header_t *this);
 };
 
 /**
- * @brief Create an ike_header_t object
+ * Create an ike_header_t object
  * 
  * @return ike_header_t object
- * 
- * @ingroup payloads
  */
 ike_header_t *ike_header_create(void);
 
-#endif /*IKE_HEADER_H_*/
+#endif /*IKE_HEADER_H_ @} */