- Updated to new upstream.

1 files changed, 39 insertions, 61 deletions

diff --git a/src/charon/encoding/payloads/transform_substructure.h b/src/charon/encoding/payloads/transform_substructure.h
index 97f587d5d..6be4b6d1e 100644
--- a/src/charon/encoding/payloads/transform_substructure.h
+++ b/src/charon/encoding/payloads/transform_substructure.h
@@ -1,10 +1,3 @@
-/**
- * @file transform_substructure.h
- * 
- * @brief Interface of transform_substructure_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: transform_substructure.h 3589 2008-03-13 14:14:44Z martin $
+ */
+
+/**
+ * @defgroup transform_substructure transform_substructure
+ * @{ @ingroup payloads
  */
 
 #ifndef TRANSFORM_SUBSTRUCTURE_H_
@@ -39,25 +39,19 @@ typedef struct transform_substructure_t transform_substructure_t;
 
 /**
  * IKEv1 Value for a transform payload.
- * 
- * @ingroup payloads
  */
 #define TRANSFORM_TYPE_VALUE 3
 
 /**
  * Length of the transform substructure header in bytes.
- * 
- * @ingroup payloads
  */
 #define TRANSFORM_SUBSTRUCTURE_HEADER_LENGTH 8
 
 
 /**
- * @brief Class representing an IKEv2- TRANSFORM SUBSTRUCTURE.
+ * Class representing an IKEv2- TRANSFORM SUBSTRUCTURE.
  * 
  * The TRANSFORM SUBSTRUCTURE format is described in RFC section 3.3.2.
- * 
- * @ingroup payloads
  */
 struct transform_substructure_t {
 	/**
@@ -66,121 +60,105 @@ struct transform_substructure_t {
 	payload_t payload_interface;
 	
 	/**
-	 * @brief Creates an iterator of stored transform_attribute_t objects.
-	 * 
-	 * @warning The created iterator has to get destroyed by the caller!
+	 * Creates an iterator of stored transform_attribute_t objects.
 	 * 
-	 * @warning When deleting an transform attribute using this iterator, 
-	 * 			the length of this transform substructure has to be refreshed 
-	 * 			by calling get_length()!
+	 * When deleting an transform attribute using this iterator, 
+	 * the length of this transform substructure has to be refreshed 
+	 * by calling get_length().
 	 *
-	 * @param this 			calling transform_substructure_t object
-	 * @param[in] forward 	iterator direction (TRUE: front to end)
+	 * @param forward 		iterator direction (TRUE: front to end)
 	 * @return				created iterator_t object.
 	 */
-	iterator_t * (*create_transform_attribute_iterator) (transform_substructure_t *this, bool forward);
+	iterator_t * (*create_transform_attribute_iterator) (
+								transform_substructure_t *this, bool forward);
 	
 	/**
-	 * @brief Adds a transform_attribute_t object to this object.
-	 * 
-	 * @warning The added proposal_substructure_t object  is 
-	 * 			getting destroyed in destroy function of transform_substructure_t.
+	 * Adds a transform_attribute_t object to this object.
 	 *
-	 * @param this 		calling transform_substructure_t object
 	 * @param proposal  transform_attribute_t object to add
 	 */
-	void (*add_transform_attribute) (transform_substructure_t *this,transform_attribute_t *attribute);
+	void (*add_transform_attribute) (transform_substructure_t *this,
+									 transform_attribute_t *attribute);
 	
 	/**
-	 * @brief Sets the next_payload field of this substructure
+	 * Sets the next_payload field of this substructure
 	 * 
 	 * If this is the last transform, next payload field is set to 0,
 	 * otherwise to 3
 	 *
-	 * @param this 		calling transform_substructure_t object
 	 * @param is_last	When TRUE, next payload field is set to 0, otherwise to 3
 	 */
 	void (*set_is_last_transform) (transform_substructure_t *this, bool is_last);
 	
 	/**
-	 * @brief Checks if this is the last transform.
+	 * Checks if this is the last transform.
 	 * 
-	 * @param this 		calling transform_substructure_t object
 	 * @return 			TRUE if this is the last Transform, FALSE otherwise
 	 */
 	bool (*get_is_last_transform) (transform_substructure_t *this);
 	
 	/**
-	 * @brief Sets transform type of the current transform substructure.
+	 * Sets transform type of the current transform substructure.
 	 *
-	 * @param this 		calling transform_substructure_t object
 	 * @param type		type value to set
 	 */
-	void (*set_transform_type) (transform_substructure_t *this,u_int8_t type);
+	void (*set_transform_type) (transform_substructure_t *this, u_int8_t type);
 	
 	/**
-	 * @brief get transform type of the current transform.
+	 * get transform type of the current transform.
 	 * 
-	 * @param this 		calling transform_substructure_t object
 	 * @return 			Transform type of current transform substructure.
 	 */
 	u_int8_t (*get_transform_type) (transform_substructure_t *this);
 	
 	/**
-	 * @brief Sets transform id of the current transform substructure.
+	 * Sets transform id of the current transform substructure.
 	 *
-	 * @param this 		calling transform_substructure_t object
-	 * @param id			transform id to set
+	 * @param id		transform id to set
 	 */
-	void (*set_transform_id) (transform_substructure_t *this,u_int16_t id);
+	void (*set_transform_id) (transform_substructure_t *this, u_int16_t id);
 	
 	/**
-	 * @brief get transform id of the current transform.
+	 * get transform id of the current transform.
 	 * 
-	 * @param this 		calling transform_substructure_t object
 	 * @return 			Transform id of current transform substructure.
 	 */
 	u_int16_t (*get_transform_id) (transform_substructure_t *this);
 	
 	/**
-	 * @brief get transform id of the current transform.
+	 * get transform id of the current transform.
 	 * 
-	 * @param this 			calling transform_substructure_t object
-	 * @param key_length		The key length is written to this location	
+	 * @param key_length	The key length is written to this location	
 	 * @return 			
 	 * 						- SUCCESS if a key length attribute is contained
 	 * 						- FAILED if no key length attribute is part of this 
 	 * 						  transform or key length uses more then 16 bit!
 	 */
-	status_t (*get_key_length) (transform_substructure_t *this,u_int16_t *key_length);
+	status_t (*get_key_length) (transform_substructure_t *this,
+								u_int16_t *key_length);
 
 	/**
-	 * @brief Clones an transform_substructure_t object.
+	 * Clones an transform_substructure_t object.
 	 *
-	 * @param this 	transform_substructure_t object to clone
 	 * @return		cloned transform_substructure_t object
 	 */
 	transform_substructure_t* (*clone) (transform_substructure_t *this);
 
 	/**
-	 * @brief Destroys an transform_substructure_t object.
-	 *
-	 * @param this 	transform_substructure_t object to destroy
+	 * Destroys an transform_substructure_t object.
 	 */
 	void (*destroy) (transform_substructure_t *this);
 };
 
 /**
- * @brief Creates an empty transform_substructure_t object.
+ * Creates an empty transform_substructure_t object.
  * 
  * @return			created transform_substructure_t object
- * 
- * @ingroup payloads
  */
 transform_substructure_t *transform_substructure_create(void);
 
 /**
- * @brief Creates an empty transform_substructure_t object.
+ * Creates an empty transform_substructure_t object.
  * 
  * The key length is used for the transport types ENCRYPTION_ALGORITHM,
  * PSEUDO_RANDOM_FUNCTION, INTEGRITY_ALGORITHM. For all 
@@ -190,9 +168,9 @@ transform_substructure_t *transform_substructure_create(void);
  * @param transform_id		transform id specifying the specific algorithm of a transform type
  * @param key_length		Key length for key lenght attribute
  * @return					transform_substructure_t object
- * 
- * @ingroup payloads
  */
-transform_substructure_t *transform_substructure_create_type(transform_type_t transform_type, u_int16_t transform_id, u_int16_t key_length);
+transform_substructure_t *transform_substructure_create_type(
+						transform_type_t transform_type, u_int16_t transform_id,
+						u_int16_t key_length);
 
-#endif /*TRANSFORM_SUBSTRUCTURE_H_*/
+#endif /*TRANSFORM_SUBSTRUCTURE_H_ @} */