merged the modularization branch (credentials) back to trunk

src/charon/encoding/payloads/unknown_payload.h

@@ -1,10 +1,3 @@
-/**
- * @file unknown_payload.h
- * 
- * @brief Interface of unknown_payload_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 unknown_payload unknown_payload
+ * @{ @ingroup payloads
  */
 
 #ifndef UNKNOWN_PAYLOAD_H_
@@ -31,22 +31,15 @@ typedef struct unknown_payload_t unknown_payload_t;
 
 /**
  * Header length of the unknown payload.
- * 
- * @ingroup payloads
  */
 #define UNKNOWN_PAYLOAD_HEADER_LENGTH 4
 
 /**
- * @brief Payload which can't be processed further.
+ * Payload which can't be processed further.
  *
  * When the parser finds an unknown payload, he builds an instance of
  * this class. This allows further processing of this payload, such as
  * a check for the critical bit in the header.
- *
- * @b Constructors:
- * - unknown_payload_create()
- *
- * @ingroup payloads
  */
 struct unknown_payload_t {
 	
@@ -56,40 +49,33 @@ struct unknown_payload_t {
 	payload_t payload_interface;
 	
 	/**
-	 * @brief Get the raw data of this payload, without 
+	 * Get the raw data of this payload, without 
 	 * the generic payload header.
 	 * 
 	 * Returned data are NOT copied and must not be freed.
 	 *
-	 * @param this 			calling unknown_payload_t object
 	 * @return				data as chunk_t
 	 */
 	chunk_t (*get_data) (unknown_payload_t *this);
 	
 	/**
-	 * @brief Get the critical flag.
+	 * Get the critical flag.
 	 *
-	 * @param this			calling unknown_payload_t object
 	 * @return				TRUE if payload is critical, FALSE if not
 	 */
 	bool (*is_critical) (unknown_payload_t *this);
 	
 	/**
-	 * @brief Destroys an unknown_payload_t object.
-	 *
-	 * @param this 	unknown_payload_t object to destroy
+	 * Destroys an unknown_payload_t object.
 	 */
 	void (*destroy) (unknown_payload_t *this);
 };
 
 /**
- * @brief Creates an empty unknown_payload_t object.
+ * Creates an empty unknown_payload_t object.
  * 
  * @return unknown_payload_t object
- * 
- * @ingroup payloads
  */
 unknown_payload_t *unknown_payload_create(void);
 
-
-#endif /* UNKNOWN_PAYLOAD_H_ */
+#endif /* UNKNOWN_PAYLOAD_H_ @} */