[Refactor] 青魔法のソースファイルに関するDoxygenコメント追加．

diff --git a/src/blue-magic/blue-magic-ball-bolt.cpp b/src/blue-magic/blue-magic-ball-bolt.cpp
index aa836f4..966d714 100644 (file)
--- a/src/blue-magic/blue-magic-ball-bolt.cpp
+++ b/src/blue-magic/blue-magic-ball-bolt.cpp
@@ -1,4 +1,9 @@
-#include "blue-magic/blue-magic-ball-bolt.h"
+/*!
+ * @file blue-magic-ball-bolt.cpp
+ * @brief 青魔法のボール/ボルト系呪文定義
+ */
+
+#include "blue-magic/blue-magic-ball-bolt.h"
 #include "blue-magic/blue-magic-util.h"
 #include "monster-race/race-ability-flags.h"
 #include "mspell/mspell-damage-calculator.h"

diff --git a/src/blue-magic/blue-magic-ball-bolt.h b/src/blue-magic/blue-magic-ball-bolt.h
index 4069b10..2cfcf39 100644 (file)
--- a/src/blue-magic/blue-magic-ball-bolt.h
+++ b/src/blue-magic/blue-magic-ball-bolt.h
@@ -1,4 +1,8 @@
 #pragma once
+/*!
+ * @file blue-magic-ball-bolt.h
+ * @brief 青魔法のボール/ボルト系呪文ヘッダ
+ */
 
 #include "system/angband.h"
 

diff --git a/src/blue-magic/blue-magic-breath.cpp b/src/blue-magic/blue-magic-breath.cpp
index 57d0ffa..669f496 100644 (file)
--- a/src/blue-magic/blue-magic-breath.cpp
+++ b/src/blue-magic/blue-magic-breath.cpp
@@ -1,4 +1,9 @@
-#include "blue-magic/blue-magic-breath.h"
+/*!
+ * @file blue-magic-breath.cpp
+ * @brief 青魔法のブレス系呪文定義
+ */
+
+#include "blue-magic/blue-magic-breath.h"
 #include "blue-magic/blue-magic-util.h"
 #include "mind/mind-blue-mage.h"
 #include "monster-race/race-ability-flags.h"

diff --git a/src/blue-magic/blue-magic-breath.h b/src/blue-magic/blue-magic-breath.h
index 976ed4d..82cc60a 100644 (file)
--- a/src/blue-magic/blue-magic-breath.h
+++ b/src/blue-magic/blue-magic-breath.h
@@ -1,4 +1,9 @@
 #pragma once
+/*!
+ * @file blue-magic-breath.h
+ * @brief 青魔法のブレス系呪文ヘッダ
+ */
+
 
 #include "system/angband.h"
 

diff --git a/src/blue-magic/blue-magic-caster.cpp b/src/blue-magic/blue-magic-caster.cpp
index 73184bc..7830002 100644 (file)
--- a/src/blue-magic/blue-magic-caster.cpp
+++ b/src/blue-magic/blue-magic-caster.cpp
@@ -1,4 +1,9 @@
-#include "blue-magic/blue-magic-caster.h"
+/*!
+ * @file blue-magic-caster.cpp
+ * @brief 青魔法のその他系統の呪文定義と詠唱時分岐処理
+ */
+
+#include "blue-magic/blue-magic-caster.h"
 #include "blue-magic/blue-magic-ball-bolt.h"
 #include "blue-magic/blue-magic-breath.h"
 #include "blue-magic/blue-magic-spirit-curse.h"

diff --git a/src/blue-magic/blue-magic-caster.h b/src/blue-magic/blue-magic-caster.h
index 909b5dd..ff5c11d 100644 (file)
--- a/src/blue-magic/blue-magic-caster.h
+++ b/src/blue-magic/blue-magic-caster.h
@@ -1,4 +1,8 @@
 #pragma once
+/*!
+ * @file blue-magic-caster.h
+ * @brief 青魔法のその他系統の呪文定義と詠唱時分岐処理ヘッダ
+ */
 
 #include "system/angband.h"
 

diff --git a/src/blue-magic/blue-magic-checker.cpp b/src/blue-magic/blue-magic-checker.cpp
index 7e2ef62..da24598 100644 (file)
--- a/src/blue-magic/blue-magic-checker.cpp
+++ b/src/blue-magic/blue-magic-checker.cpp
@@ -1,4 +1,5 @@
 /*!
+ * @file blue-magic-checker.cpp
  * @brief 青魔法の処理実装 / Blue magic
  * @date 2014/01/15
  * @author

diff --git a/src/blue-magic/blue-magic-checker.h b/src/blue-magic/blue-magic-checker.h
index 8feedb1..9659600 100644 (file)
--- a/src/blue-magic/blue-magic-checker.h
+++ b/src/blue-magic/blue-magic-checker.h
@@ -1,4 +1,8 @@
 #pragma once
+/*!
+ * @file blue-magic-checker.h
+ * @brief 青魔法の処理ヘッダ / Blue magic
+ */
 
 #include "system/angband.h"
 

diff --git a/src/blue-magic/blue-magic-spirit-curse.cpp b/src/blue-magic/blue-magic-spirit-curse.cpp
index 0e7b778..53fc8a0 100644 (file)
--- a/src/blue-magic/blue-magic-spirit-curse.cpp
+++ b/src/blue-magic/blue-magic-spirit-curse.cpp
@@ -1,4 +1,10 @@
-#include "blue-magic/blue-magic-spirit-curse.h"
+/*!
+ * @file blue-magic-spirit-curse.cpp
+ * @brief 青魔法の呪い系処理定義
+ */
+
+
+#include "blue-magic/blue-magic-spirit-curse.h"
 #include "blue-magic/blue-magic-util.h"
 #include "monster-race/race-ability-flags.h"
 #include "mspell/mspell-damage-calculator.h"

diff --git a/src/blue-magic/blue-magic-spirit-curse.h b/src/blue-magic/blue-magic-spirit-curse.h
index 4f87b86..bd17bc6 100644 (file)
--- a/src/blue-magic/blue-magic-spirit-curse.h
+++ b/src/blue-magic/blue-magic-spirit-curse.h
@@ -1,4 +1,8 @@
 #pragma once
+/*!
+ * @file blue-magic-spirit-curse.h
+ * @brief 青魔法の呪い系処理ヘッダ
+ */
 
 #include "system/angband.h"
 

diff --git a/src/blue-magic/blue-magic-status.cpp b/src/blue-magic/blue-magic-status.cpp
index dff7a12..7c6721f 100644 (file)
--- a/src/blue-magic/blue-magic-status.cpp
+++ b/src/blue-magic/blue-magic-status.cpp
@@ -1,9 +1,15 @@
-#include "blue-magic/blue-magic-status.h"
+/*!
+ * @file blue-magic-status.cpp
+ * @brief 青魔法の状態異常系スペル定義
+ */
+
+#include "blue-magic/blue-magic-status.h"
 #include "blue-magic/blue-magic-util.h"
 #include "spell/spells-status.h"
 #include "target/target-getter.h"
 #include "view/display-messages.h"
 
+
 bool cast_blue_scare(player_type *caster_ptr, bmc_type *bmc_ptr)
 {
     if (!get_aim_dir(caster_ptr, &bmc_ptr->dir))

diff --git a/src/blue-magic/blue-magic-status.h b/src/blue-magic/blue-magic-status.h
index 1fca097..733d3e1 100644 (file)
--- a/src/blue-magic/blue-magic-status.h
+++ b/src/blue-magic/blue-magic-status.h
@@ -1,4 +1,8 @@
 #pragma once
+/*!
+ * @file blue-magic-status.h
+ * @brief 青魔法の状態異常系スペルヘッダ
+ */
 
 #include "system/angband.h"
 

diff --git a/src/blue-magic/blue-magic-summon.cpp b/src/blue-magic/blue-magic-summon.cpp
index 27d19cf..faecd19 100644 (file)
--- a/src/blue-magic/blue-magic-summon.cpp
+++ b/src/blue-magic/blue-magic-summon.cpp
@@ -1,4 +1,9 @@
-#include "blue-magic/blue-magic-summon.h"
+/*!
+ * @file blue-magic-summon.cpp
+ * @brief 青魔法の召喚系スペル定義
+ */
+
+#include "blue-magic/blue-magic-summon.h"
 #include "blue-magic/blue-magic-util.h"
 #include "monster-floor/monster-summon.h"
 #include "monster-floor/place-monster-types.h"

diff --git a/src/blue-magic/blue-magic-summon.h b/src/blue-magic/blue-magic-summon.h
index 5122376..9aa448e 100644 (file)
--- a/src/blue-magic/blue-magic-summon.h
+++ b/src/blue-magic/blue-magic-summon.h
@@ -1,4 +1,8 @@
 #pragma once
+/*!
+ * @file blue-magic-summon.h
+ * @brief 青魔法の召喚系スペルヘッダ
+ */
 
 #include "system/angband.h"
 

diff --git a/src/blue-magic/blue-magic-util.cpp b/src/blue-magic/blue-magic-util.cpp
index 8ec36df..7183a93 100644 (file)
--- a/src/blue-magic/blue-magic-util.cpp
+++ b/src/blue-magic/blue-magic-util.cpp
@@ -1,4 +1,9 @@
-#include "blue-magic/blue-magic-util.h"
+/*!
+ * @file blue-magic-util.cpp
+ * @brief 青魔法の構造体、初期化処理定義
+ */
+
+#include "blue-magic/blue-magic-util.h"
 #include "monster-floor/place-monster-types.h"
 
 bmc_type *initialize_blue_magic_type(

diff --git a/src/blue-magic/blue-magic-util.h b/src/blue-magic/blue-magic-util.h
index c1142ae..901bcfc 100644 (file)
--- a/src/blue-magic/blue-magic-util.h
+++ b/src/blue-magic/blue-magic-util.h
@@ -1,4 +1,8 @@
 #pragma once
+/*!
+ * @file blue-magic-util.h
+ * @brief 青魔法の構造体、初期化処理ヘッダ
+ */
 
 #include "system/angband.h"
 

diff --git a/src/blue-magic/learnt-info.cpp b/src/blue-magic/learnt-info.cpp
index fc8e3f4..26049d5 100644 (file)
--- a/src/blue-magic/learnt-info.cpp
+++ b/src/blue-magic/learnt-info.cpp
@@ -1,4 +1,9 @@
-#include "blue-magic/learnt-info.h"
+/*!
+ * @file learnt-info.cpp
+ * @brief 青魔法の情報表示処理定義
+ */
+
+#include "blue-magic/learnt-info.h"
 #include "cmd-action/cmd-spell.h"
 #include "lore/lore-calculator.h" //!< @todo 少し違和感.
 #include "monster-race/race-ability-flags.h"

diff --git a/src/blue-magic/learnt-info.h b/src/blue-magic/learnt-info.h
index 38c9245..8aa8c00 100644 (file)
--- a/src/blue-magic/learnt-info.h
+++ b/src/blue-magic/learnt-info.h
@@ -1,4 +1,8 @@
 #pragma once
+/*!
+ * @file learnt-info.h
+ * @brief 青魔法の情報表示処理ヘッダ
+ */
 
 #include "system/angband.h"
 

diff --git a/src/blue-magic/learnt-power-getter.cpp b/src/blue-magic/learnt-power-getter.cpp
index 4ac7ba2..d116982 100644 (file)
--- a/src/blue-magic/learnt-power-getter.cpp
+++ b/src/blue-magic/learnt-power-getter.cpp
@@ -1,4 +1,9 @@
-#include "blue-magic/learnt-power-getter.h"
+/*!
+ * @file learnt-power-getter.cpp
+ * @brief 青魔法の処理実行定義
+ */
+
+#include "blue-magic/learnt-power-getter.h"
 #include "blue-magic/blue-magic-checker.h"
 #include "blue-magic/learnt-info.h"
 #include "core/asking-player.h"

diff --git a/src/blue-magic/learnt-power-getter.h b/src/blue-magic/learnt-power-getter.h
index 4b862cf..f6cba05 100644 (file)
--- a/src/blue-magic/learnt-power-getter.h
+++ b/src/blue-magic/learnt-power-getter.h
@@ -1,4 +1,8 @@
 #pragma once
+/*!
+ * @file learnt-power-getter.h
+ * @brief 青魔法の処理実行ヘッダ
+ */
 
 #include "system/angband.h"