From 689bec313716f629c4b671a2dfdcafc367b806e7 Mon Sep 17 00:00:00 2001 From: Deskull Date: Sun, 10 Aug 2014 18:19:23 +0900 Subject: [PATCH] Fix Doxygen warnings in some files. --- src/spells3.c | 14 +++++++------- src/streams.c | 2 -- src/tables.c | 1 - src/types.h | 35 ++++++++++++++++++----------------- 4 files changed, 25 insertions(+), 27 deletions(-) diff --git a/src/spells3.c b/src/spells3.c index 7b4f69e7f..018c29588 100644 --- a/src/spells3.c +++ b/src/spells3.c @@ -913,7 +913,7 @@ int choose_dungeon(cptr note, int y, int x) /*! * @brief プレイヤーの帰還発動及び中止処理 / * Recall the player to town or dungeon - * @param turn 発動までのターン数 + * @param turns 発動までのターン数 * @return 常にTRUEを返す */ bool recall_player(int turns) @@ -4093,12 +4093,12 @@ bool spell_okay(int spell, bool learned, bool study_pray, int use_realm) /*! * @brief 呪文情報の表示処理 / * Print a list of spells (for browsing or casting or viewing) - * @spells target_spell 呪文ID - * @spells spells アクセス開始するスペルの参照ポイント - * @spells num 表示する - * @spells y 表示メッセージ左上Y座標 - * @spells x 表示メッセージ左上X座標 - * @spells use_realm 魔法領域ID + * @param target_spell 呪文ID + * @param spells アクセス開始するスペルの参照ポイント + * @param num 表示する + * @param y 表示メッセージ左上Y座標 + * @param x 表示メッセージ左上X座標 + * @param use_realm 魔法領域ID * @return なし */ void print_spells(int target_spell, byte *spells, int num, int y, int x, int use_realm) diff --git a/src/streams.c b/src/streams.c index 6b4d0419c..6673852fb 100644 --- a/src/streams.c +++ b/src/streams.c @@ -11,11 +11,9 @@ * are included in all such copies. Other copyrights may also apply. * * @details - *
  * Purpose:  This file holds all the
  * functions that are applied to a level after the rest has been
  * generated, ie streams and level destruction.
- * 
*/ #include "angband.h" diff --git a/src/tables.c b/src/tables.c index e778ea7b4..d1e4af7ef 100644 --- a/src/tables.c +++ b/src/tables.c @@ -5,7 +5,6 @@ * @author *
  * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke
- *
  * This software may be copied and distributed for educational, research,
  * and not for profit purposes provided that this copyright and statement
  * are included in all such copies.  Other copyrights may also apply.
diff --git a/src/types.h b/src/types.h
index a854337ec..17d2c9924 100644
--- a/src/types.h
+++ b/src/types.h
@@ -59,35 +59,36 @@ struct feature_state
 };
 
 
-/*
- * Information about terrain "features"
+/*!
+ * @struct feature_type
+ * @brief 地形情報の構造体 / Information about terrain "features"
  */
 
 typedef struct feature_type feature_type;
 
 struct feature_type
 {
-	u32b name;                /* Name (offset) */
-	u32b text;                /* Text (offset) */
-	s16b tag;                 /* Tag (offset) */
+	u32b name;                /*!< 地形名参照のためのネームバッファオフセット値 / Name (offset) */
+	u32b text;                /*!< 地形説明参照のためのネームバッファオフセット値 /  Text (offset) */
+	s16b tag;                 /*!< 地形特性タグ参照のためのネームバッファオフセット値 /  Tag (offset) */
 
-	s16b mimic;               /* Feature to mimic */
+	s16b mimic;               /*!< 未確定時の外形地形ID / Feature to mimic */
 
-	u32b flags[FF_FLAG_SIZE]; /* Flags */
+	u32b flags[FF_FLAG_SIZE]; /*!< 地形の基本特性ビット配列 / Flags */
 
-	u16b priority;            /* Map priority */
-	s16b destroyed;           /* Default destroyed state */
+	u16b priority;            /*!< 縮小表示で省略する際の表示優先度 / Map priority */
+	s16b destroyed;           /*!< 一度*破壊*に巻き込まれたかどうかのフラグ / Default destroyed state */
 
-	feature_state state[MAX_FEAT_STATES];
+	feature_state state[MAX_FEAT_STATES]; /*!< feature_state テーブル */
 
-	byte subtype;
-	byte power;
+	byte subtype;  /*!< 副特性値 */
+	byte power;    /*!< 地形強度 */
 
-	byte d_attr[F_LIT_MAX];   /* Default feature attribute */
-	byte d_char[F_LIT_MAX];   /* Default feature character */
+	byte d_attr[F_LIT_MAX];   /*!< デフォルトの地形シンボルカラー / Default feature attribute */
+	byte d_char[F_LIT_MAX];   /*!< デフォルトの地形シンボルアルファベット / Default feature character */
 
-	byte x_attr[F_LIT_MAX];   /* Desired feature attribute */
-	byte x_char[F_LIT_MAX];   /* Desired feature character */
+	byte x_attr[F_LIT_MAX];   /*!< 設定変更後の地形シンボルカラー / Desired feature attribute */
+	byte x_char[F_LIT_MAX];   /*!< 設定変更後の地形シンボルアルファベット / Desired feature character */
 };
 
 
@@ -138,7 +139,7 @@ struct object_kind
 	byte d_char;		/*!< デフォルトのアイテムシンボルアルファベット / Default object character */
 
 	byte x_attr;		/*!< 設定変更後のアイテムシンボルカラー /  Desired object attribute */
-	byte x_char;		/*!< 設定変更後のアイテムシンボルカラー /  Desired object character */
+	byte x_char;		/*!< 設定変更後のアイテムシンボルアルファベット /  Desired object character */
 
 	s16b flavor;		/*!< 調査中(TODO) / Special object flavor (or zero) */
 
-- 
2.11.0