- doxygen constructor declaration, make default ?

This commit is contained in:
Martin Willi
2005-12-04 14:45:57 +00:00
parent fc5b6b3b65
commit 0743de26be
3 changed files with 17 additions and 0 deletions
@@ -51,6 +51,11 @@ typedef struct hasher_t hasher_t;
/** /**
* @brief Generic interface for all hash functions. * @brief Generic interface for all hash functions.
* *
* @b Constructors:
* - hasher_create()
*
* @see md5_hasher_t, sha1_hasher_t
*
* @ingroup hashers * @ingroup hashers
*/ */
struct hasher_t { struct hasher_t {
@@ -32,6 +32,12 @@ typedef struct md5_hasher_t md5_hasher_t;
* @brief Implementation of hasher_t interface using the * @brief Implementation of hasher_t interface using the
* MD5 algorithm. * MD5 algorithm.
* *
* @b Constructors:
* - hasher_create() using HASH_MD5
* - md5_hasher_create()
*
* @see hasher_t
*
* @ingroup hashers * @ingroup hashers
*/ */
struct md5_hasher_t { struct md5_hasher_t {
@@ -32,6 +32,12 @@ typedef struct sha1_hasher_t sha1_hasher_t;
* @brief Implementation of hasher_t interface using the * @brief Implementation of hasher_t interface using the
* SHA1 algorithm. * SHA1 algorithm.
* *
* @b Constructors:
* - hasher_create() using HASH_SHA1
* - sha1_hasher_create()
*
* @see hasher_t
*
* @ingroup hashers * @ingroup hashers
*/ */
struct sha1_hasher_t { struct sha1_hasher_t {