X-Git-Url: http://j8takagi.net/cgi-bin/gitweb.cgi?p=YACASL2.git;a=blobdiff_plain;f=include%2Fhash.h;h=e1aa5025721fe11718b532030751d71b18b28558;hp=9821b44b70311859b33abc1d0d8006c6058ad0e8;hb=7afcf780cbc7d4f2834b9ca42cca1b3754621960;hpb=e07b6371cc8a59c6793a895e968ff2c6cf28181b

diff --git a/include/hash.h b/include/hash.h
index 9821b44..e1aa502 100644
--- a/include/hash.h
+++ b/include/hash.h
@@ -1,22 +1,34 @@
-#ifndef YACASL2_HASH_INCLUDED
-#define YACASL2_HASH_INCLUDED
+#ifndef YACASL2_HASH_H_INCLUDED
+#define YACASL2_HASH_H_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