[svn-upgrade] Integrating new upstream version, strongswan (4.2.4)

1 files changed, 22 insertions, 42 deletions

diff --git a/src/charon/encoding/payloads/transform_attribute.h b/src/charon/encoding/payloads/transform_attribute.h
index 30583b23f..891155913 100644
--- a/src/charon/encoding/payloads/transform_attribute.h
+++ b/src/charon/encoding/payloads/transform_attribute.h
@@ -1,10 +1,3 @@
-/**
- * @file transform_attribute.h
- * 
- * @brief Interface of transform_attribute_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_attribute.h 3589 2008-03-13 14:14:44Z martin $
+ */
+
+/**
+ * @defgroup transform_attribute transform_attribute
+ * @{ @ingroup payloads
  */
 
 #ifndef TRANSFORM_ATTRIBUTE_H_
@@ -33,8 +33,6 @@ typedef struct transform_attribute_t transform_attribute_t;
 
 /**
  * Type of the attribute, as in IKEv2 RFC 3.3.5.
- * 
- * @ingroup payloads
  */
 enum transform_attribute_type_t {
 	ATTRIBUTE_UNDEFINED = 16384,
@@ -43,17 +41,13 @@ enum transform_attribute_type_t {
 
 /** 
  * enum name for transform_attribute_type_t.
- * 
- * @ingroup payloads
  */
 extern enum_name_t *transform_attribute_type_names;
 
 /**
- * @brief Class representing an IKEv2- TRANSFORM Attribute.
+ * Class representing an IKEv2- TRANSFORM Attribute.
  * 
  * The TRANSFORM ATTRIBUTE format is described in RFC section 3.3.5.
- * 
- * @ingroup payloads
  */
 struct transform_attribute_t {
 	/**
@@ -62,93 +56,79 @@ struct transform_attribute_t {
 	payload_t payload_interface;
 
 	/**
-	 * @brief Returns the currently set value of the attribute.
+	 * Returns the currently set value of the attribute.
 	 * 	
-	 * @warning Returned data are not copied.
+	 * Returned data are not copied.
 	 * 
-	 * @param this 	calling transform_attribute_t object
 	 * @return 		chunk_t pointing to the value
 	 */
 	chunk_t (*get_value_chunk) (transform_attribute_t *this);
 	
 	/**
-	 * @brief Returns the currently set value of the attribute.
+	 * Returns the currently set value of the attribute.
 	 * 	
-	 * @warning Returned data are not copied.
+	 * Returned data are not copied.
 	 * 
-	 * @param this 	calling transform_attribute_t object
 	 * @return 		value
 	 */
 	u_int16_t (*get_value) (transform_attribute_t *this);
 	
 	/**
-	 * @brief Sets the value of the attribute.
+	 * Sets the value of the attribute.
 	 * 	
-	 * @warning Value is getting copied.
+	 * Value is getting copied.
 	 * 
-	 * @param this 	calling transform_attribute_t object
 	 * @param value chunk_t pointing to the value to set
 	 */
 	void (*set_value_chunk) (transform_attribute_t *this, chunk_t value);
 
 	/**
-	 * @brief Sets the value of the attribute.
+	 * Sets the value of the attribute.
 	 * 
-	 * @param this 	calling transform_attribute_t object
 	 * @param value value to set
 	 */
 	void (*set_value) (transform_attribute_t *this, u_int16_t value);
 
 	/**
-	 * @brief Sets the type of the attribute.
+	 * Sets the type of the attribute.
 	 * 	
-	 * @param this 	calling transform_attribute_t object
 	 * @param type	type to set (most significant bit is set to zero)
 	 */
 	void (*set_attribute_type) (transform_attribute_t *this, u_int16_t type);
 	
 	/**
-	 * @brief get the type of the attribute.
+	 * get the type of the attribute.
 	 * 	
-	 * @param this 	calling transform_attribute_t object
 	 * @return 		type of the value
 	 */
 	u_int16_t (*get_attribute_type) (transform_attribute_t *this);
 	
 	/**
-	 * @brief Clones an transform_attribute_t object.
+	 * Clones an transform_attribute_t object.
 	 *
-	 * @param this 	transform_attribute_t object to clone
 	 * @return		cloned transform_attribute_t object
 	 */
 	transform_attribute_t * (*clone) (transform_attribute_t *this);
 
 	/**
-	 * @brief Destroys an transform_attribute_t object.
-	 *
-	 * @param this 	transform_attribute_t object to destroy
+	 * Destroys an transform_attribute_t object.
 	 */
 	void (*destroy) (transform_attribute_t *this);
 };
 
 /**
- * @brief Creates an empty transform_attribute_t object.
+ * Creates an empty transform_attribute_t object.
  * 
  * @return				transform_attribute_t object
- * 
- * @ingroup payloads
  */
 transform_attribute_t *transform_attribute_create(void);
 
 /**
- * @brief Creates an transform_attribute_t of type KEY_LENGTH.
+ * Creates an transform_attribute_t of type KEY_LENGTH.
  * 
  * @param key_length	key length in bytes
  * @return				transform_attribute_t object
- * 
- * @ingroup payloads
  */
 transform_attribute_t *transform_attribute_create_key_length(u_int16_t key_length);
 
-
-#endif /*TRANSFORM_ATTRIBUTE_H_*/
+#endif /*TRANSFORM_ATTRIBUTE_H_ @} */