自動拾い/破壊設定のデータベースに関わる構造体や変数に Doxygen コメントを付加。 / Add Doxygen comments to the structure...

diff --git a/src/types.h b/src/types.h
index 17d2c99..060293e 100644 (file)
--- a/src/types.h
+++ b/src/types.h
@@ -1633,16 +1633,17 @@ struct dungeon_info_type {
 };
 
 
-/*
- *  A structure type for entry of auto-picker/destroyer
+/*!
+ * @struct autopick_type
+ * @brief 自動拾い/破壊設定データの構造体 / A structure type for entry of auto-picker/destroyer
  */
 typedef struct {
-       cptr name;          /* Items which have 'name' as part of its name match */
-       cptr insc;          /* Items will be auto-inscribed as 'insc' */
-       u32b flag[2];       /* Misc. keyword to be matched */
-       byte action;        /* Auto-pickup or Destroy or Leave items */
-       byte dice;          /* Weapons which have more than 'dice' dice match */
-       byte bonus;         /* Items which have more than 'bonus' magical bonus match */
+       cptr name;          /*!< 自動拾い/破壊定義の名称一致基準 / Items which have 'name' as part of its name match */
+       cptr insc;          /*!< 対象となったアイテムに自動で刻む内容 / Items will be auto-inscribed as 'insc' */
+       u32b flag[2];       /*!< キーワードに関する汎用的な条件フラグ / Misc. keyword to be matched */
+       byte action;        /*!< 対象のアイテムを拾う/破壊/放置するかの指定フラグ / Auto-pickup or Destroy or Leave items */
+       byte dice;          /*!< 武器のダイス値基準値 / Weapons which have more than 'dice' dice match */
+       byte bonus;         /*!< アイテムのボーナス基準値 / Items which have more than 'bonus' magical bonus match */
 } autopick_type;
 
 

diff --git a/src/variable.c b/src/variable.c
index e29519a..f10bf7b 100644 (file)
--- a/src/variable.c
+++ b/src/variable.c
@@ -37,11 +37,11 @@ int level_up = 0; /*!< レベルアップの際に遅延してcalc_mana()関数
 
 
 /* 
- *  List for auto-picker/destroyer entries
+ * 自動拾い/破壊設定のリストに関する変数 / List for auto-picker/destroyer entries
  */
-int max_autopick = 0;
-int max_max_autopick = 0;
-autopick_type *autopick_list = NULL;
+int max_autopick = 0; /*!< 現在登録している自動拾い/破壊設定の数 */
+int max_max_autopick = 0; /*!< 自動拾い/破壊設定の限界数 */
+autopick_type *autopick_list = NULL; /*!< 自動拾い/破壊設定構造体のポインタ配列 */
 
 /*
  * Savefile version