ドキュメントの修正

[YACASL2.git] / include / hash.h

diff --git a/include/hash.h b/include/hash.h
index d438735..817e8e9 100644 (file)
--- a/include/hash.h
+++ b/include/hash.h
@@ -1,27 +1,34 @@
 #ifndef YACASL2_HASH_INCLUDED
 #define YACASL2_HASH_INCLUDED
 
-#include "cmem.h"
-
-/* ハッシュ共用体の型 */
+/**
+ * @brief ハッシュ共用体の数値
+ */
 typedef enum {
-    CHARS = 0,
-    INT = 1,
+    CHARS = 0,                  /**<char型のデータ */
+    INT = 1,                    /**<int型のデータ  */
 } UTYPE;
 
-/* ハッシュ共用体 */
+/**
+ * @brief ハッシュ共用体のデータ型
+ */
 typedef struct {
-    UTYPE type;
+    UTYPE type;                 /**<ハッシュ値の元データのデータ型 */
     union {
-        char *s;
-        int i;
-    } val;
+        char *s;                /**<char型のデータ */
+        int i;                  /**<int型のデータ */
+    } val;                      /**<ハッシュ値の元データ */
 } HKEY;
 
-/* ハッシュ表のサイズを決めるため、引数の数値未満で最大の素数を返す */
-int hashtabsize(int size);
-
-/* ハッシュ値を取得する */
+/**
+ * @brief ハッシュ値を取得する
+ *
+ * @return ハッシュ値
+ *
+ * @param keyc キーの数
+ * @param *keyv[] キーを表す配列
+ * @param tabsize テーブルのサイズ
+ */
 unsigned hash(int keyc, HKEY *keyv[], int tabsize);
 
 #endif