doxygen用にコメント修正。関数のstatic指定を外す

[YACASL2.git] / include / hash.h

diff --git a/include/hash.h b/include/hash.h
index 9821b44..361e251 100644 (file)
--- a/include/hash.h
+++ b/include/hash.h
@@ -1,22 +1,28 @@
 #ifndef YACASL2_HASH_INCLUDED
 #define YACASL2_HASH_INCLUDED
 
-/* ハッシュ共用体の型 */
+/**
+ * ハッシュ共用体の型
+ */
 typedef enum {
     CHARS = 0,
     INT = 1,
 } UTYPE;
 
-/* ハッシュ共用体 */
+/**
+ * ハッシュ共用体
+ */
 typedef struct {
-    UTYPE type;
+    UTYPE type;                 /**<ハッシュ値の元データのデータ型 */
     union {
-        char *s;
-        int i;
-    } val;
+        char *s;                /**<char型のデータ */
+        int i;                  /**<int型のデータ */
+    } val;                      /**<ハッシュ値の元データ */
 } HKEY;
 
-/* ハッシュ値を取得する */
+/**
+ * ハッシュ値を取得する
+ */
 unsigned hash(int keyc, HKEY *keyv[], int tabsize);
 
 #endif