OSDN Git Service

Add Doxygen comments to other functions to xtra1.c.
authorDeskull <desull@users.sourceforge.jp>
Sun, 7 Sep 2014 11:52:49 +0000 (20:52 +0900)
committerDeskull <desull@users.sourceforge.jp>
Sun, 7 Sep 2014 11:52:49 +0000 (20:52 +0900)
xtra1.c 内の残り関数全てに Doxygen コメントを追加。

src/xtra1.c

index 0ab85b3..3841746 100644 (file)
@@ -6271,7 +6271,11 @@ void handle_stuff(void)
        if (p_ptr->window) window_stuff();
 }
 
-
+/*!
+ * @brief プレイヤーの現在開いている手の状態を返す
+ * @param riding_control 乗馬中により片手を必要としている状態ならばTRUEを返す。
+ * @return 開いている手のビットフラグ
+ */
 s16b empty_hands(bool riding_control)
 {
        s16b status = EMPTY_HAND_NONE;
@@ -6289,6 +6293,10 @@ s16b empty_hands(bool riding_control)
 }
 
 
+/*!
+ * @brief プレイヤーが防具重量制限のある職業時にペナルティを受ける状態にあるかどうかを返す。
+ * @return ペナルティが適用されるならばTRUE。
+ */
 bool heavy_armor(void)
 {
        u16b monk_arm_wgt = 0;
@@ -6307,6 +6315,9 @@ bool heavy_armor(void)
        return (monk_arm_wgt > (100 + (p_ptr->lev * 4)));
 }
 
+/*!
+ * @brief 実ゲームプレイ時間を更新する
+ */
 void update_playtime(void)
 {
        /* Check if the game has started */