aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/transforms/prf_plus.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/charon/transforms/prf_plus.h')
-rw-r--r--Source/charon/transforms/prf_plus.h19
1 files changed, 11 insertions, 8 deletions
diff --git a/Source/charon/transforms/prf_plus.h b/Source/charon/transforms/prf_plus.h
index 812af05aa..538724c48 100644
--- a/Source/charon/transforms/prf_plus.h
+++ b/Source/charon/transforms/prf_plus.h
@@ -32,10 +32,13 @@ typedef struct prf_plus_t prf_plus_t;
/**
* @brief Implementation of the prf+ function described in IKEv2 draft.
*
- * This class implements the prf+ algorithm. Internalliy it uses a pseudo random
+ * This class implements the prf+ algorithm. Internally it uses a pseudo random
* function, which implements the prf_t interface.
- *
- * @see IKEv2 draft 2.13
+ *
+ * See IKEv2 draft 2.13.
+ *
+ * @b Constructors:
+ * - prf_plus_create()
*
* @ingroup transforms
*/
@@ -46,7 +49,7 @@ struct prf_plus_t {
* Get the next few bytes of the prf+ output. Space
* must be allocated by the caller.
*
- * @param this calling prf_plus
+ * @param this calling object
* @param length number of bytes to get
* @param[out] buffer pointer where the generated bytes will be written
*/
@@ -58,7 +61,7 @@ struct prf_plus_t {
* Get the next few bytes of the prf+ output. This function
* will allocate the required space.
*
- * @param this calling prf_plus
+ * @param this calling object
* @param length number of bytes to get
* @param[out] chunk chunk which will hold generated bytes
*/
@@ -67,7 +70,7 @@ struct prf_plus_t {
/**
* @brief Destroys a prf_plus_t object.
*
- * @param this prf_plus_t object to destroy
+ * @param this calling object
*/
void (*destroy) (prf_plus_t *this);
};
@@ -77,11 +80,11 @@ struct prf_plus_t {
*
* Seed will be cloned. prf will
* not be cloned, must be destroyed outside after
- * prf_plus usage.
+ * prf_plus_t usage.
*
* @param prf prf object to use
* @param seed input seed for prf
- * @return created prf_plus_t
+ * @return prf_plus_t object
*
* @ingroup transforms
*/