merged the modularization branch (credentials) back to trunk

src/libstrongswan/crypto/diffie_hellman.h

@@ -1,10 +1,3 @@
-/**
- * @file diffie_hellman.h
- * 
- * @brief Interface of diffie_hellman_t.
- * 
- */
-
 /*
  * Copyright (C) 2005-2007 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 diffie_hellman diffie_hellman
+ * @{ @ingroup crypto
  */
 
 #ifndef DIFFIE_HELLMAN_H_
@@ -30,13 +30,10 @@ typedef struct diffie_hellman_t diffie_hellman_t;
 #include <library.h>
 
 /**
- * @brief Diffie-Hellman group.
+ * Diffie-Hellman group.
  *
  * The modulus (or group) to use for a Diffie-Hellman calculation.
- *
  * See IKEv2 RFC 3.3.2 and RFC 3526.
- *
- * @ingroup crypto
  */
 enum diffie_hellman_group_t {
 	MODP_NONE = 0,
@@ -56,89 +53,60 @@ enum diffie_hellman_group_t {
 extern enum_name_t *diffie_hellman_group_names;
 
 /**
- * @brief Implementation of the Diffie-Hellman algorithm, as in RFC2631.
- * 
- * @b Constructors:
- *  - diffie_hellman_create()
- * 
- * @ingroup crypto
+ * Implementation of the Diffie-Hellman algorithm, as in RFC2631.
  */
 struct diffie_hellman_t {
 		
 	/**
-	 * @brief Returns the shared secret of this diffie hellman exchange.
+	 * Returns the shared secret of this diffie hellman exchange.
 	 * 	
 	 * Space for returned secret is allocated and must be 
 	 * freed by the caller.
 	 * 
-	 * @param this 		calling object
 	 * @param secret 	shared secret will be written into this chunk
-	 * @return 				
-	 * 					- SUCCESS
-	 * 					- FAILED if not both DH values are set
+	 * @return 			SUCCESS, FAILED if not both DH values are set
 	 */
 	status_t (*get_shared_secret) (diffie_hellman_t *this, chunk_t *secret);
 	
 	/**
-	 * @brief Sets the public value of partner.
+	 * Sets the public value of partner.
 	 * 	
 	 * Chunk gets cloned and can be destroyed afterwards.
 	 * 
-	 * @param this 		calling object
 	 * @param value 	public value of partner
 	 */
 	void (*set_other_public_value) (diffie_hellman_t *this, chunk_t value);
 	
 	/**
-	 * @brief Gets the public value of partner.
+	 * Gets the public value of partner.
 	 * 	
 	 * Space for returned chunk is allocated and must be freed by the caller.
 	 * 
-	 * @param this 		calling object
 	 * @param value 	public value of partner is stored at this location
-	 * @return 				
-	 * 					- SUCCESS
-	 * 					- FAILED if other public value not set
+	 * @return 			SUCCESS, FAILED if other public value not set
 	 */
 	status_t (*get_other_public_value) (diffie_hellman_t *this, chunk_t *value);
 	
 	/**
-	 * @brief Gets the own public value to transmit.
+	 * Gets the own public value to transmit.
 	 * 	
 	 * Space for returned chunk is allocated and must be freed by the caller.
 	 * 
-	 * @param this 		calling object
 	 * @param value		public value of caller is stored at this location
 	 */
 	void (*get_my_public_value) (diffie_hellman_t *this, chunk_t *value);
 	
 	/**
-	 * @brief Get the DH group used.
+	 * Get the DH group used.
 	 * 
-	 * @param this 		calling object
 	 * @return			DH group set in construction
 	 */
 	diffie_hellman_group_t (*get_dh_group) (diffie_hellman_t *this);
 
 	/**
-	 * @brief Destroys an diffie_hellman_t object.
-	 *
-	 * @param this 		diffie_hellman_t object to destroy
+	 * Destroys an diffie_hellman_t object.
 	 */
 	void (*destroy) (diffie_hellman_t *this);
 };
 
-/**
- * @brief Creates a new diffie_hellman_t object.
- * 
- * @param group			Diffie Hellman group number to use
- * @return
- * 						- diffie_hellman_t object
- * 						- NULL if dh group not supported
- * 
- * @ingroup crypto
- */
-diffie_hellman_t *diffie_hellman_create(diffie_hellman_group_t group);
-
-#endif /*DIFFIE_HELLMAN_H_*/
-
+#endif /*DIFFIE_HELLMAN_H_ @} */