Add Doxygen comment to effects.c.

diff --git a/src/effects.c b/src/effects.c
index 45b3861..d0f734e 100644 (file)
--- a/src/effects.c
+++ b/src/effects.c
@@ -1,17 +1,26 @@
-/* File: effects.c */
-
-/*
- * 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.
+/*!
+ * @file effects.c
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¥¹¥Æ¡¼¥¿¥¹´ÉÍý / effects of various "objects"
+ * @date 2014/01/01
+ * @author
+ * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke\n
+ *\n
+ * This software may be copied and distributed for educational, research,\n
+ * and not for profit purposes provided that this copyright and statement\n
+ * are included in all such copies.  Other copyrights may also apply.\n
+ *\n
+ * 2013 Deskull rearranged comment for Doxygen.\n
  */
 
-/* Purpose: effects of various "objects" */
 
 #include "angband.h"
 
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î·Ñ³¹ÔÆ°¤òÀßÄꤹ¤ë¡£
+ * @param typ ·Ñ³¹ÔÆ°¤ÎID\n
+ * #ACTION_NONE / #ACTION_SEARCH / #ACTION_REST / #ACTION_LEARN / #ACTION_FISH / #ACTION_KAMAE / #ACTION_KATA / #ACTION_SING / #ACTION_HAYAGAKE / #ACTION_SPELL ¤«¤éÁªÂò¡£
+ * @return ¤Ê¤·
+ */
 void set_action(int typ)
 {
        int prev_typ = p_ptr->action;
@@ -160,7 +169,10 @@ void set_action(int typ)
        p_ptr->redraw |= (PR_STATE);
 }
 
-/* reset timed flags */
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ÎÁ´¤Æ¤Î»þ¸Â¸ú²Ì¤ò¥ê¥»¥Ã¥È¤¹¤ë¡£ / reset timed flags
+ * @return ¤Ê¤·
+ */
 void reset_tim_flags(void)
 {
        p_ptr->fast = 0;            /* Timed -- Fast */
@@ -243,7 +255,10 @@ void reset_tim_flags(void)
        }
 }
 
-
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤ËËâÎϾõî¸ú²Ì¤òÍ¿¤¨¤ë¡£
+ * @return ¤Ê¤·
+ */
 void dispel_player(void)
 {
        (void)set_fast(0, TRUE);
@@ -331,9 +346,13 @@ void dispel_player(void)
 }
 
 
-/*
- * Set "p_ptr->tim_mimic", and "p_ptr->mimic_form",
- * notice observable changes
+/*!
+ * @brief Êѿȸú²Ì¤Î·Ñ³»þ´Ö¤ÈÊÑ¿ÈÀè¤ò¥»¥Ã¥È¤¹¤ë / Set "p_ptr->tim_mimic", and "p_ptr->mimic_form", notice observable changes
+ * @param v ·Ñ³»þ´Ö
+ * @param p ÊÑ¿ÈÆâÍÆ
+ * @param do_dec (¸½ºß»È¤ï¤ì¤Æ¤¤¤Ê¤¤)
+ * @todo do_dec¤Î¼ÂÁõ¤ò³Îǧ¤Î¾å½¤Àµ¤¹¤ë¤³¤È¡£
+ * @return ¥¹¥Æ¡¼¥¿¥¹¤Ë±Æ¶Á¤òµÚ¤Ü¤¹ÊѲ½¤¬¤¢¤Ã¤¿¾ì¹çTRUE¤òÊÖ¤¹¡£
  */
 bool set_mimic(int v, int p, bool do_dec)
 {
@@ -402,13 +421,15 @@ bool set_mimic(int v, int p, bool do_dec)
        return (TRUE);
 }
 
-/*
- * Set "p_ptr->blind", notice observable changes
- *
- * Note the use of "PU_UN_LITE" and "PU_UN_VIEW", which is needed to
- * memorize any terrain features which suddenly become "visible".
- * Note that blindness is currently the only thing which can affect
- * "player_can_see_bold()".
+/*!
+ * @brief ÌÕÌܤηѳ»þ´Ö¤ò¥»¥Ã¥È¤¹¤ë / Set "p_ptr->blind", notice observable changes
+ * @param v ·Ñ³»þ´Ö
+ * @return ¥¹¥Æ¡¼¥¿¥¹¤Ë±Æ¶Á¤òµÚ¤Ü¤¹ÊѲ½¤¬¤¢¤Ã¤¿¾ì¹çTRUE¤òÊÖ¤¹¡£
+ * @details
+ * Note the use of "PU_UN_LITE" and "PU_UN_VIEW", which is needed to\n
+ * memorize any terrain features which suddenly become "visible".\n
+ * Note that blindness is currently the only thing which can affect\n
+ * "player_can_see_bold()".\noo
  */
 bool set_blind(int v)
 {