From 0743de26be9165d5f8cece84f6d5a82bf503c7d8 Mon Sep 17 00:00:00 2001 From: Martin Willi Date: Sun, 4 Dec 2005 14:45:57 +0000 Subject: [PATCH] - doxygen constructor declaration, make default ? --- Source/charon/transforms/hashers/hasher.h | 5 +++++ Source/charon/transforms/hashers/md5_hasher.h | 6 ++++++ Source/charon/transforms/hashers/sha1_hasher.h | 6 ++++++ 3 files changed, 17 insertions(+) diff --git a/Source/charon/transforms/hashers/hasher.h b/Source/charon/transforms/hashers/hasher.h index 90cf89eff..e207b30f1 100644 --- a/Source/charon/transforms/hashers/hasher.h +++ b/Source/charon/transforms/hashers/hasher.h @@ -51,6 +51,11 @@ typedef struct hasher_t hasher_t; /** * @brief Generic interface for all hash functions. * + * @b Constructors: + * - hasher_create() + * + * @see md5_hasher_t, sha1_hasher_t + * * @ingroup hashers */ struct hasher_t { diff --git a/Source/charon/transforms/hashers/md5_hasher.h b/Source/charon/transforms/hashers/md5_hasher.h index f73fdb528..9a4b53e15 100644 --- a/Source/charon/transforms/hashers/md5_hasher.h +++ b/Source/charon/transforms/hashers/md5_hasher.h @@ -32,6 +32,12 @@ typedef struct md5_hasher_t md5_hasher_t; * @brief Implementation of hasher_t interface using the * MD5 algorithm. * + * @b Constructors: + * - hasher_create() using HASH_MD5 + * - md5_hasher_create() + * + * @see hasher_t + * * @ingroup hashers */ struct md5_hasher_t { diff --git a/Source/charon/transforms/hashers/sha1_hasher.h b/Source/charon/transforms/hashers/sha1_hasher.h index c712e4b40..d5c0c3230 100644 --- a/Source/charon/transforms/hashers/sha1_hasher.h +++ b/Source/charon/transforms/hashers/sha1_hasher.h @@ -32,6 +32,12 @@ typedef struct sha1_hasher_t sha1_hasher_t; * @brief Implementation of hasher_t interface using the * SHA1 algorithm. * + * @b Constructors: + * - hasher_create() using HASH_SHA1 + * - sha1_hasher_create() + * + * @see hasher_t + * * @ingroup hashers */ struct sha1_hasher_t {