merged the modularization branch (credentials) back to trunk

src/libstrongswan/crypto/prfs/prf.h

@@ -1,10 +1,3 @@
-/**
- * @file prf.h
- * 
- * @brief Interface prf_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 prf prf
+ * @{ @ingroup crypto
  */
 
 #ifndef PRF_H_
@@ -30,12 +30,10 @@ typedef struct prf_t prf_t;
 #include <library.h>
 
 /**
- * @brief Pseudo random function, as in IKEv2 RFC 3.3.2.
+ * Pseudo random function, as in IKEv2 RFC 3.3.2.
  *
  * PRF algorithms not defined in IKEv2 are allocated in "private use"
  * space.
- *
- * @ingroup prfs
  */
 enum pseudo_random_function_t {
 	PRF_UNDEFINED = 1024,
@@ -63,80 +61,53 @@ enum pseudo_random_function_t {
 extern enum_name_t *pseudo_random_function_names;
 
 /**
- * @brief Generic interface for pseudo-random-functions.
- * 
- * @b Constructors:
- *  - prf_create()
- *  - hmac_prf_create()
- * 
- * @todo Implement more prf algorithms
- * 
- * @ingroup prfs
+ * Generic interface for pseudo-random-functions.
  */
 struct prf_t {
 	/**
-	 * @brief Generates pseudo random bytes and writes them in the buffer.
+	 * Generates pseudo random bytes and writes them in the buffer.
 	 *
-	 * @param this			calling object
-	 * @param seed			a chunk containing the seed for the next bytes
-	 * @param[out] buffer	pointer where the generated bytes will be written
+	 * @param seed		a chunk containing the seed for the next bytes
+	 * @param buffer	pointer where the generated bytes will be written
 	 */
 	void (*get_bytes) (prf_t *this, chunk_t seed, u_int8_t *buffer);
 	
 	/**
-	 * @brief Generates pseudo random bytes and allocate space for them.
+	 * Generates pseudo random bytes and allocate space for them.
 	 * 
-	 * @param this			calling object
-	 * @param seed			a chunk containing the seed for the next bytes
-	 * @param[out] chunk	chunk which will hold generated bytes
+	 * @param seed		a chunk containing the seed for the next bytes
+	 * @param chunk		chunk which will hold generated bytes
 	 */
 	void (*allocate_bytes) (prf_t *this, chunk_t seed, chunk_t *chunk);
 	
 	/**
-	 * @brief Get the block size of this prf_t object.
+	 * Get the block size of this prf_t object.
 	 * 
-	 * @param this			calling object
-	 * @return				block size in bytes
+	 * @return			block size in bytes
 	 */
 	size_t (*get_block_size) (prf_t *this);
 	
 	/**
-	 * @brief Get the key size of this prf_t object.
+	 * Get the key size of this prf_t object.
 	 *
 	 * This is a suggestion only, all implemented PRFs accept variable key
 	 * length.
 	 * 
-	 * @param this			calling object
-	 * @return				key size in bytes
+	 * @return			key size in bytes
 	 */
 	size_t (*get_key_size) (prf_t *this);
 	
 	/**
-	 * @brief Set the key for this prf_t object.
+	 * Set the key for this prf_t object.
 	 * 
-	 * @param this			calling object
-	 * @param key			key to set
+	 * @param key		key to set
 	 */
 	void (*set_key) (prf_t *this, chunk_t key);
 	
 	/**
-	 * @brief Destroys a prf object.
-	 *
-	 * @param this 			calling object
+	 * Destroys a prf object.
 	 */
 	void (*destroy) (prf_t *this);
 };
 
-/**
- * @brief Generic constructor for a prf_t oject.
- * 
- * @param pseudo_random_function	Algorithm to use
- * @return
- * 									- prf_t object
- * 									- NULL if prf algorithm not supported
- *
- * @ingroup prfs
- */
-prf_t *prf_create(pseudo_random_function_t pseudo_random_function);
-
-#endif /*PRF_H_*/
+#endif /*PRF_H_ @} */