Mercurial > hg > ucx / changeset

--- a/src/cx/hash_key.h	Sat Jan 04 17:37:47 2025 +0100
+++ b/src/cx/hash_key.h	Sat Jan 04 17:46:32 2025 +0100
@@ -26,11 +26,11 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 /**
- * \file hash_key.h
- * \brief Interface for map implementations.
- * \author Mike Becker
- * \author Olaf Wintermann
- * \copyright 2-Clause BSD License
+ * @file hash_key.h
+ * @brief Interface for map implementations.
+ * @author Mike Becker
+ * @author Olaf Wintermann
+ * @copyright 2-Clause BSD License
  */
 
 
@@ -62,14 +62,18 @@
 typedef struct cx_hash_key_s CxHashKey;
 
 /**
- * Computes a murmur2 32 bit hash.
+ * Computes a murmur2 32-bit hash.
  *
- * You need to initialize \c data and \c len in the key struct.
+ * You need to initialize @c data and @c len in the key struct.
  * The hash is then directly written to that struct.
  *
- * \note If \c data is \c NULL, the hash is defined as 1574210520.
+ * Usually you should not need this function.
+ * Use cx_hash_key(), instead.
+ *
+ * @note If @c data is @c NULL, the hash is defined as 1574210520.
  *
  * @param key the key, the hash shall be computed for
+ * @see cx_hash_key()
  */
 cx_attr_nonnull
 void cx_hash_murmur(CxHashKey *key);
@@ -132,8 +136,8 @@
 /**
  * Computes a hash key from a UCX string.
  *
- * @param str the string
- * @return the hash key
+ * @param str (@c cxstring or @c cxmutstr) the string
+ * @return (@c CxHashKey) the hash key
  */
 #define cx_hash_key_cxstr(str) cx_hash_key_cxstr(cx_strcast(str))