X-Git-Url: http://j8takagi.net/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=include%2Fhash.h;h=817e8e9f3677ddd1f8d99c98f9f7e106fe822a86;hb=8808be96beb5502d13c0cd957b9fc3cec72ac6e3;hp=9821b44b70311859b33abc1d0d8006c6058ad0e8;hpb=0e3065564e83037d5fbbb3e0e1595e7ce95ce8eb;p=YACASL2.git

diff --git a/include/hash.h b/include/hash.h
index 9821b44..817e8e9 100644
--- a/include/hash.h
+++ b/include/hash.h
@@ -1,22 +1,34 @@
 #ifndef YACASL2_HASH_INCLUDED
 #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);
 
 #endif