Doxygenドキュメントで関数などに概要とパラメーター、返り値が表示されるよう修正

[YACASL2.git] / include / hash.h

diff --git a/include/hash.h b/include/hash.h
index 361e251..817e8e9 100644 (file)
--- a/include/hash.h
+++ b/include/hash.h
@@ -2,15 +2,15 @@
 #define YACASL2_HASH_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);