X-Git-Url: http://j8takagi.net/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fhash.h;h=817e8e9f3677ddd1f8d99c98f9f7e106fe822a86;hb=47bce10199bfd1545b94803ce653b3301103aee7;hp=3c05972890a2264ac26a7042e78559e95c34bca2;hpb=d1f82970bf7d41db2fea11b08cd8e308f6cb8138;p=YACASL2.git

diff --git a/include/hash.h b/include/hash.h
index 3c05972..817e8e9 100644
--- a/include/hash.h
+++ b/include/hash.h
@@ -2,26 +2,32 @@
 #define YACASL2_HASH_INCLUDED
 
 /**
- * ハッシュ共用体の型
+ * @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;
 
 /**
- * ハッシュ値を取得する
+ * @brief ハッシュ値を取得する
+ *
+ * @return ハッシュ値
+ *
+ * @param keyc キーの数
+ * @param *keyv[] キーを表す配列
+ * @param tabsize テーブルのサイズ
  */
 unsigned hash(int keyc, HKEY *keyv[], int tabsize);