From: Michal Vaner <vorner@ucw.cz>
Date: Sun, 14 Sep 2008 14:02:00 +0000 (+0200)
Subject: ucw docs: hashfunc reflects the syntax change
X-Git-Tag: holmes-import~289
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=b09773df69403d903beac3d75ff1d7665cbbc55e;p=libucw.git

ucw docs: hashfunc reflects the syntax change
---

diff --git a/ucw/hashfunc.h b/ucw/hashfunc.h
index 2e045b27..7250119a 100644
--- a/ucw/hashfunc.h
+++ b/ucw/hashfunc.h
@@ -16,18 +16,18 @@
 /*** === String hashes [[strhash]] ***/
 
 /* The following functions need str to be aligned to sizeof(uns).  */
-uns str_len_aligned(const char *str) PURE; /** Get the string length (not a really useful hash function, but there is no better place for it). The string must be aligned to sizeof(uns). For unaligned see str_len(). **/
-uns hash_string_aligned(const char *str) PURE; /** Hash the string. The string must be aligned to sizeof(uns). For unaligned see hash_string(). **/
-uns hash_block_aligned(const byte *str, uns len) PURE; /** Hash arbitrary data. They must be aligned to sizeof(uns). For unaligned see hash_block(). **/
+uns str_len_aligned(const char *str) PURE; /** Get the string length (not a really useful hash function, but there is no better place for it). The string must be aligned to sizeof(uns). For unaligned see @str_len(). **/
+uns hash_string_aligned(const char *str) PURE; /** Hash the string. The string must be aligned to sizeof(uns). For unaligned see @hash_string(). **/
+uns hash_block_aligned(const byte *str, uns len) PURE; /** Hash arbitrary data. They must be aligned to sizeof(uns). For unaligned see @hash_block(). **/
 
 #ifdef	CPU_ALLOW_UNALIGNED
 #define	str_len(str)		str_len_aligned(str)
 #define	hash_string(str)	hash_string_aligned(str)
 #define	hash_block(str, len)	hash_block_aligned(str, len)
 #else
-uns str_len(const char *str) PURE; /** Get the string length. If you know it is aligned to sizeof(uns), you can use faster str_len_aligned(). **/
-uns hash_string(const char *str) PURE; /** Hash the string. If it is aligned to sizeof(uns), you can use faster hash_string_aligned(). **/
-uns hash_block(const byte *str, uns len) PURE; /** Hash arbitrary data. If they are aligned to sizeof(uns), use faster hash_block_aligned(). **/
+uns str_len(const char *str) PURE; /** Get the string length. If you know it is aligned to sizeof(uns), you can use faster @str_len_aligned(). **/
+uns hash_string(const char *str) PURE; /** Hash the string. If it is aligned to sizeof(uns), you can use faster @hash_string_aligned(). **/
+uns hash_block(const byte *str, uns len) PURE; /** Hash arbitrary data. If they are aligned to sizeof(uns), use faster @hash_block_aligned(). **/
 #endif
 
 uns hash_string_nocase(const char *str) PURE; /** Hash the string in a case insensitive way. Works only with ASCII characters. **/
diff --git a/ucw/md5.h b/ucw/md5.h
index 6980a1f9..75966cac 100644
--- a/ucw/md5.h
+++ b/ucw/md5.h
@@ -27,7 +27,7 @@ void md5_init(md5_context *context); /** Initialize the MD5 hashing algorithm in
  */
 void md5_update(md5_context *context, const byte *buf, uns len);
 /**
- * Call this after the last md5_update(). It will terminate the
+ * Call this after the last @md5_update(). It will terminate the
  * algorithm and return a pointer to the result.
  *
  * Note that the data it points to are stored inside the @context, so
diff --git a/ucw/sha1.h b/ucw/sha1.h
index 55809ee0..2527e09a 100644
--- a/ucw/sha1.h
+++ b/ucw/sha1.h
@@ -30,12 +30,12 @@ void sha1_init(sha1_context *hd); /** Initialize new algorithm run in the @hd co
  * Push another @inlen bytes of data pointed to by @inbuf onto the
  * SHA1 hash currently in @hd. You can call this any times you want on
  * the same hash (and you do not need to reinitialize it by
- * sha1_init()). It has the same effect as concatenating all the data
+ * @sha1_init()). It has the same effect as concatenating all the data
  * together and passing them at once.
  */
 void sha1_update(sha1_context *hd, const byte *inbuf, uns inlen);
 /**
- * No more sha1_update() calls will be done. This terminates the hash
+ * No more @sha1_update() calls will be done. This terminates the hash
  * and returns a pointer to it.
  *
  * Note that the pointer points into data in the @hd context. If it ceases