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

diff --git a/include/hash.h b/include/hash.h
index 361e251..e1aa502 100644
--- a/include/hash.h
+++ b/include/hash.h
@@ -1,16 +1,16 @@
-#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;                 /**<ハッシュ値の元データのデータ型 */
@@ -21,7 +21,13 @@ typedef struct {
 } HKEY;
 
 /**
- * ハッシュ値を取得する
+ * @brief ハッシュ値を取得する
+ *
+ * @return ハッシュ値
+ *
+ * @param keyc キーの数
+ * @param *keyv[] キーを表す配列
+ * @param tabsize テーブルのサイズ
  */
 unsigned hash(int keyc, HKEY *keyv[], int tabsize);