Add Doxygen comment to files.c.

[hengband/hengband.git] / src / hex.c

diff --git a/src/hex.c b/src/hex.c
index 049714d..224d4bc 100644 (file)
--- a/src/hex.c
+++ b/src/hex.c
@@ -1,19 +1,28 @@
-#include "angband.h"
+/*!
+ * @file hex.c
+ * @brief ¼ö½Ñ¤Î½èÍý¼ÂÁõ / Hex code
+ * @date 2014/01/14
+ * @author
+ * 2014 Deskull rearranged comment for Doxygen.\n
+ * @details
+ * p_ptr-magic_num1\n
+ * 0: Flag bits of spelling spells\n
+ * 1: Flag bits of despelled spells\n
+ * 2: Revange damage\n
+ * p_ptr->magic_num2\n
+ * 0: Number of spelling spells\n
+ * 1: Type of revenge\n
+ * 2: Turn count for revenge\n
+ */
 
-/* Flag list */
-/*
-p_ptr-magic_num1
-0: Flag bits of spelling spells
-1: Flag bits of despelled spells
-2: Revange damage
-p_ptr->magic_num2
-0: Number of spelling spells
-1: Type of revenge
-2: Turn count for revenge
-*/
+#include "angband.h"
 
-#define MAX_KEEP 4
+#define MAX_KEEP 4 /*!<¼ö½Ñ¤ÎºÇÂç±Ó¾§¿ô */
 
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤¬±Ó¾§Ãæ¤ÎÁ´¼ö½Ñ¤òÄä»ß¤¹¤ë
+ * @return ¤Ê¤·
+ */
 bool stop_hex_spell_all(void)
 {
        int i;
@@ -37,7 +46,10 @@ bool stop_hex_spell_all(void)
        return TRUE;
 }
 
-
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤¬±Ó¾§Ãæ¤Î¼ö½Ñ¤«¤é°ì¤Ä¤òÁª¤ó¤ÇÄä»ß¤¹¤ë
+ * @return ¤Ê¤·
+ */
 bool stop_hex_spell(void)
 {
        int spell;
@@ -122,8 +134,11 @@ bool stop_hex_spell(void)
 }
 
 
-/* Upkeeping hex spells
-   Called from dungeon.c */
+/*!
+ * @brief °ìÄê»þ´ÖËè¤Ë¼ö½Ñ¤Ç¾ÃÈñ¤¹¤ëMP¤ò½èÍý¤¹¤ë /
+ * Upkeeping hex spells Called from dungeon.c
+ * @return ¤Ê¤·
+ */
 void check_hex(void)
 {
        int spell;
@@ -232,7 +247,10 @@ void check_hex(void)
        }
 }
 
-
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î¼ö½Ñ±Ó¾§ÏȤ¬¤¹¤Ç¤ËºÇÂ礫¤É¤¦¤«¤òÊÖ¤¹
+ * @return ¤¹¤Ç¤ËÁ´ÏȤòÍøÍѤ·¤Æ¤¤¤ë¤Ê¤éTRUE¤òÊÖ¤¹
+ */
 bool hex_spell_fully(void)
 {
        int k_max = 0;
@@ -247,7 +265,11 @@ bool hex_spell_fully(void)
        return TRUE;
 }
 
-void revenge_spell()
+/*!
+ * @brief °ìÄꥲ¡¼¥à¥¿¡¼¥óËè¤ËÉü½²½èÍý¤Î»Ä¤ê´ü´Ö¤ÎȽÄê¤ò¹Ô¤¦
+ * @return ¤Ê¤·
+ */
+void revenge_spell(void)
 {
        if (p_ptr->realm1 != REALM_HEX) return;
        if (p_ptr->magic_num2[2] <= 0) return;
@@ -259,6 +281,11 @@ void revenge_spell()
        }
 }
 
+/*!
+ * @brief Éü½²¥À¥á¡¼¥¸¤ÎÄɲäò¹Ô¤¦
+ * @param dam ÃßÀѤµ¤ì¤ë¥À¥á¡¼¥¸ÎÌ
+ * @return ¤Ê¤·
+ */
 void revenge_store(int dam)
 {
        if (p_ptr->realm1 != REALM_HEX) return;
@@ -267,7 +294,11 @@ void revenge_store(int dam)
        p_ptr->magic_num1[2] += dam;
 }
 
-
+/*!
+ * @brief È¿¥Æ¥ì¥Ý¡¼¥È·ë³¦¤ÎȽÄê
+ * @param m_idx ȽÄê¤ÎÂоݤȤʤë¥â¥ó¥¹¥¿¡¼ID
+ * @return È¿¥Æ¥ì¥Ý¡¼¥È¤Î¸ú²Ì¤¬Å¬ÍѤµ¤ì¤ë¤Ê¤éTRUE¤òÊÖ¤¹
+ */
 bool teleport_barrier(int m_idx)
 {
        monster_type *m_ptr = &m_list[m_idx];
@@ -279,7 +310,11 @@ bool teleport_barrier(int m_idx)
        return TRUE;
 }
 
-
+/*!
+ * @brief È¿ËâË¡·ë³¦¤ÎȽÄê
+ * @param m_idx ȽÄê¤ÎÂоݤȤʤë¥â¥ó¥¹¥¿¡¼ID
+ * @return È¿ËâË¡¤Î¸ú²Ì¤¬Å¬ÍѤµ¤ì¤ë¤Ê¤éTRUE¤òÊÖ¤¹
+ */
 bool magic_barrier(int m_idx)
 {
        monster_type *m_ptr = &m_list[m_idx];
@@ -291,7 +326,11 @@ bool magic_barrier(int m_idx)
        return TRUE;
 }
 
-
+/*!
+ * @brief È¿Áý¿£·ë³¦¤ÎȽÄê
+ * @param m_idx ȽÄê¤ÎÂоݤȤʤë¥â¥ó¥¹¥¿¡¼ID
+ * @return È¿Áý¿£¤Î¸ú²Ì¤¬Å¬ÍѤµ¤ì¤ë¤Ê¤éTRUE¤òÊÖ¤¹
+ */
 bool multiply_barrier(int m_idx)
 {
        monster_type *m_ptr = &m_list[m_idx];