• R/O
  • HTTP
  • SSH
  • HTTPS

hengband: Commit

変愚蛮怒のメインリポジトリです


Commit MetaInfo

Revision48ffa395c0518d1e6cf21ffe85ad2c85421e5341 (tree)
Time2013-12-31 18:48:37
Authordeskull <deskull@0568...>
Commiterdeskull

Log Message

Add Doxygen comment to do-spell.c.

Change Summary

Incremental Difference

--- a/src/do-spell.c
+++ b/src/do-spell.c
@@ -205,8 +205,12 @@ static cptr info_weight(int weight)
205205 }
206206
207207
208-/*
209- * Prepare standard probability to become beam for fire_bolt_or_beam()
208+/*!
209+ * @brief 一部ボルト魔法のビーム化確率を算出する / Prepare standard probability to become beam for fire_bolt_or_beam()
210+ * @return ビーム化確率(%)
211+ * @details
212+ * ハードコーティングによる実装が行われている。
213+ * メイジは(レベル)%、ハイメイジ、スペルマスターは(レベル)%、それ以外の職業は(レベル/2)%
210214 */
211215 static int beam_chance(void)
212216 {
@@ -218,9 +222,16 @@ static int beam_chance(void)
218222 return p_ptr->lev / 2;
219223 }
220224
221-
222-/*
223- * Handle summoning and failure of trump spells
225+/*!
226+ * @brief トランプ魔法独自の召喚処理を行う / Handle summoning and failure of trump spells
227+ * @param num summon_specific()関数を呼び出す回数
228+ * @param pet ペット化として召喚されるか否か
229+ * @param y 召喚位置のy座標
230+ * @param x 召喚位置のx座標
231+ * @param lev 召喚レベル
232+ * @param type 召喚条件ID
233+ * @param mode モンスター生成条件フラグ
234+ * @return モンスターが(敵対も含めて)召還されたならばTRUEを返す。
224235 */
225236 static bool trump_summoning(int num, bool pet, int y, int x, int lev, int type, u32b mode)
226237 {
@@ -277,11 +288,15 @@ static bool trump_summoning(int num, bool pet, int y, int x, int lev, int type,
277288 }
278289
279290
280-/*
281- * This spell should become more useful (more controlled) as the
282- * player gains experience levels. Thus, add 1/5 of the player's
283- * level to the die roll. This eliminates the worst effects later on,
284- * while keeping the results quite random. It also allows some potent
291+/*!
292+ * @brief 「ワンダー」のランダムな効果を決定して処理する。
293+ * @param dir 方向ID
294+ * @return なし
295+ * @details
296+ * This spell should become more useful (more controlled) as the\n
297+ * player gains experience levels. Thus, add 1/5 of the player's\n
298+ * level to the die roll. This eliminates the worst effects later on,\n
299+ * while keeping the results quite random. It also allows some potent\n
285300 * effects only at high level.
286301 */
287302 static void cast_wonder(int dir)
@@ -365,6 +380,11 @@ static void cast_wonder(int dir)
365380 }
366381
367382
383+/*!
384+ * @brief 「悪霊召喚」のランダムな効果を決定して処理する。
385+ * @param dir 方向ID
386+ * @return なし
387+ */
368388 static void cast_invoke_spirits(int dir)
369389 {
370390 int plev = p_ptr->lev;
@@ -531,7 +551,11 @@ static void cast_invoke_spirits(int dir)
531551 }
532552 }
533553
534-
554+/*!
555+ * @brief カオス的効果あるいは及びシャッフルの「運命の輪」効果を引数基準に処理する。
556+ * @param spell 基準となる引数ID
557+ * @return なし
558+ */
535559 static void wild_magic(int spell)
536560 {
537561 int counter = 0;
@@ -630,7 +654,10 @@ static void wild_magic(int spell)
630654 }
631655 }
632656
633-
657+/*!
658+ * @brief トランプ領域の「シャッフル」の効果をランダムに決めて処理する。
659+ * @return なし
660+ */
634661 static void cast_shuffle(void)
635662 {
636663 int plev = p_ptr->lev;
Show on old repository browser