OSDN -- Develop and Download Open Source Software
  • R/O
  • HTTP
  • SSH
  • HTTPS
Fork

hengband: Commit

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


Commit MetaInfo

Revision39df08379bbffb2da8bf514e2712728d1704be5f (tree)
Time2014-07-08 23:16:11
AuthorDeskull <desull@user...>
CommiterDeskull

Log Message

Add Doxygen comments to monster2.c.

Change Summary

Incremental Difference

--- a/src/monster2.c
+++ b/src/monster2.c
@@ -3705,6 +3705,12 @@ bool place_monster(int y, int x, u32b mode)
37053705
37063706 #ifdef MONSTER_HORDES
37073707
3708+/*!
3709+ * @brief 指定地点に1種類のモンスター種族による群れを生成する
3710+ * @param y 生成地点y座標
3711+ * @param x 生成地点x座標
3712+ * @return 生成に成功したらtrue
3713+ */
37083714 bool alloc_horde(int y, int x)
37093715 {
37103716 monster_race *r_ptr = NULL;
@@ -3765,8 +3771,10 @@ bool alloc_horde(int y, int x)
37653771 #endif /* MONSTER_HORDES */
37663772
37673773
3768-/*
3769- * Put the Guardian
3774+/*!
3775+ * @brief ダンジョンの主生成を試みる / Put the Guardian
3776+ * @param def_val 現在の主の生成状態
3777+ * @return 生成に成功したらtrue
37703778 */
37713779 bool alloc_guardian(bool def_val)
37723780 {
@@ -3803,13 +3811,14 @@ bool alloc_guardian(bool def_val)
38033811 }
38043812
38053813
3806-/*
3807- * Attempt to allocate a random monster in the dungeon.
3808- *
3814+/*!
3815+ * @brief ダンジョンの初期配置モンスターを生成1回生成する / Attempt to allocate a random monster in the dungeon.
3816+ * @param dis プレイヤーから離れるべき最低距離
3817+ * @param mode 生成オプション
3818+ * @return 生成に成功したらtrue
3819+ * @details
38093820 * Place the monster at least "dis" distance from the player.
3810- *
38113821 * Use "slp" to choose the initial "sleep" status
3812- *
38133822 * Use "monster_level" for the monster level
38143823 */
38153824 bool alloc_monster(int dis, u32b mode)
@@ -3877,10 +3886,10 @@ bool alloc_monster(int dis, u32b mode)
38773886 }
38783887
38793888
3880-
3881-
3882-/*
3883- * Hack -- help decide if a monster race is "okay" to summon
3889+/*!
3890+ * @brief モンスターが召喚の基本条件に合っているかをチェックする / Hack -- help decide if a monster race is "okay" to summon
3891+ * @param r_idx チェックするモンスター種族ID
3892+ * @return 召喚対象にできるならばTRUE
38843893 */
38853894 static bool summon_specific_okay(int r_idx)
38863895 {
@@ -3925,9 +3934,16 @@ static bool summon_specific_okay(int r_idx)
39253934 }
39263935
39273936
3928-/*
3929- * Place a monster (of the specified "type") near the given
3930- * location. Return TRUE if a monster was actually summoned.
3937+/*!
3938+ * @brief モンスターを召喚により配置する / Place a monster (of the specified "type") near the given location. Return TRUE if a monster was actually summoned.
3939+ * @param who 召喚主のモンスター情報ID
3940+ * @param y1 目標地点y座標
3941+ * @param x1 目標地点x座標
3942+ * @param lev 相当生成階
3943+ * @param type 召喚種別
3944+ * @param mode 生成オプション
3945+ * @return 召喚できたらtrueを返す
3946+ * @details
39313947 *
39323948 * We will attempt to place the monster up to 10 times before giving up.
39333949 *
@@ -3992,7 +4008,16 @@ bool summon_specific(int who, int y1, int x1, int lev, int type, u32b mode)
39924008 return (TRUE);
39934009 }
39944010
3995-/* A "dangerous" function, creates a pet of the specified type */
4011+
4012+/*!
4013+ * @brief 特定モンスター種族を召喚により生成する / A "dangerous" function, creates a pet of the specified type
4014+ * @param who 召喚主のモンスター情報ID
4015+ * @param oy 目標地点y座標
4016+ * @param ox 目標地点x座標
4017+ * @param r_idx 生成するモンスター種族ID
4018+ * @param mode 生成オプション
4019+ * @return 召喚できたらtrueを返す
4020+ */
39964021 bool summon_named_creature (int who, int oy, int ox, int r_idx, u32b mode)
39974022 {
39984023 int x, y;
@@ -4012,9 +4037,13 @@ bool summon_named_creature (int who, int oy, int ox, int r_idx, u32b mode)
40124037 }
40134038
40144039
4015-/*
4016- * Let the given monster attempt to reproduce.
4017- *
4040+/*!
4041+ * @brief モンスターを増殖生成する / Let the given monster attempt to reproduce.
4042+ * @param m_idx 増殖するモンスター情報ID
4043+ * @param clone クローン・モンスター処理ならばtrue
4044+ * @param mode 生成オプション
4045+ * @return 生成できたらtrueを返す
4046+ * @details
40184047 * Note that "reproduction" REQUIRES empty space.
40194048 */
40204049 bool multiply_monster(int m_idx, bool clone, u32b mode)
@@ -4044,11 +4073,12 @@ bool multiply_monster(int m_idx, bool clone, u32b mode)
40444073
40454074
40464075
4047-
4048-
4049-/*
4050- * Dump a message describing a monster's reaction to damage
4051- *
4076+/*!
4077+ * @brief ダメージを受けたモンスターの様子を記述する / Dump a message describing a monster's reaction to damage
4078+ * @param m_idx モンスター情報ID
4079+ * @param dam 与えたダメージ
4080+ * @return なし
4081+ * @details
40524082 * Technically should attempt to treat "Beholder"'s as jelly's
40534083 */
40544084 void message_pain(int m_idx, int dam)
Show on old repository browser