aboutsummaryrefslogtreecommitdiffstats
path: root/src/libstrongswan/utils/randomizer.h
diff options
context:
space:
mode:
authorMartin Willi <martin@strongswan.org>2008-03-13 14:14:44 +0000
committerMartin Willi <martin@strongswan.org>2008-03-13 14:14:44 +0000
commit552cc11b1f017ce4962fca741f567d098f768574 (patch)
tree2835ae64c435191e04b5a265b1509c40a2e6766a /src/libstrongswan/utils/randomizer.h
parent2df655134ca29f7a0b7d90ef4783f85eff1ddfd3 (diff)
downloadstrongswan-552cc11b1f017ce4962fca741f567d098f768574.tar.bz2
strongswan-552cc11b1f017ce4962fca741f567d098f768574.tar.xz
merged the modularization branch (credentials) back to trunk
Diffstat (limited to 'src/libstrongswan/utils/randomizer.h')
-rw-r--r--src/libstrongswan/utils/randomizer.h79
1 files changed, 33 insertions, 46 deletions
diff --git a/src/libstrongswan/utils/randomizer.h b/src/libstrongswan/utils/randomizer.h
index afbade059..c7aa86b01 100644
--- a/src/libstrongswan/utils/randomizer.h
+++ b/src/libstrongswan/utils/randomizer.h
@@ -1,10 +1,3 @@
-/**
- * @file randomizer.h
- *
- * @brief Interface of randomizer_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 randomizer randomizer
+ * @{ @ingroup utils
*/
#ifndef RANDOMIZER_H_
@@ -43,72 +43,59 @@ typedef struct randomizer_t randomizer_t;
#endif
/**
- * @brief Class used to get random and pseudo random values.
- *
- * @b Constructors:
- * - randomizer_create()
- *
- * @ingroup utils
+ * Class used to get random and pseudo random values.
*/
struct randomizer_t {
/**
- * @brief Reads a specific number of bytes from random device.
- *
- * @param this calling randomizer_t object
- * @param bytes number of bytes to read
- * @param[out] buffer pointer to buffer where to write the data in.
- * Size of buffer has to be at least bytes.
- * @return SUCCESS, or FAILED
+ * Reads a specific number of bytes from random device.
+ *
+ * @param bytes number of bytes to read
+ * @param buffer pointer to buffer where to write the data in.
+ * @return SUCCESS, or FAILED
*/
- status_t (*get_random_bytes) (randomizer_t *this, size_t bytes, u_int8_t *buffer);
+ status_t (*get_random_bytes) (randomizer_t *this,
+ size_t bytes, u_int8_t *buffer);
/**
- * @brief Allocates space and writes in random bytes.
+ * Allocates space and writes in random bytes.
*
- * @param this calling randomizer_t object
- * @param bytes number of bytes to allocate
- * @param[out] chunk chunk which will hold the allocated random bytes
- * @return SUCCESS, or FAILED
+ * @param bytes number of bytes to allocate
+ * @param chunk chunk which will hold the allocated random bytes
+ * @return SUCCESS, or FAILED
*/
- status_t (*allocate_random_bytes) (randomizer_t *this, size_t bytes, chunk_t *chunk);
+ status_t (*allocate_random_bytes) (randomizer_t *this,
+ size_t bytes, chunk_t *chunk);
/**
- * @brief Reads a specific number of bytes from pseudo random device.
+ * Reads a specific number of bytes from pseudo random device.
*
- * @param this calling randomizer_t object
- * @param bytes number of bytes to read
- * @param[out] buffer pointer to buffer where to write the data in.
- * size of buffer has to be at least bytes.
- * @return SUCCESS, or FAILED
+ * @param bytes number of bytes to read
+ * @param buffer pointer to buffer where to write the data in.
+ * @return SUCCESS, or FAILED
*/
status_t (*get_pseudo_random_bytes) (randomizer_t *this,size_t bytes, u_int8_t *buffer);
/**
- * @brief Allocates space and writes in pseudo random bytes.
+ * Allocates space and writes in pseudo random bytes.
*
- * @param this calling randomizer_t object
- * @param bytes number of bytes to allocate
- * @param[out] chunk chunk which will hold the allocated random bytes
- * @return SUCCESS, or FAILED
+ * @param bytes number of bytes to allocate
+ * @param chunk chunk which will hold the allocated random bytes
+ * @return SUCCESS, or FAILED
*/
status_t (*allocate_pseudo_random_bytes) (randomizer_t *this, size_t bytes, chunk_t *chunk);
/**
- * @brief Destroys a randomizer_t object.
- *
- * @param this randomizer_t object to destroy
+ * Destroys a randomizer_t object.
*/
void (*destroy) (randomizer_t *this);
};
/**
- * @brief Creates a randomizer_t object.
- *
- * @return created randomizer_t, or
+ * Creates a randomizer_t object.
*
- * @ingroup utils
+ * @return created randomizer_t
*/
randomizer_t *randomizer_create(void);
-#endif /*RANDOMIZER_H_*/
+#endif /*RANDOMIZER_H_ @} */