変愚蛮怒のメインリポジトリです
Revision | 51dd92836dd69d713e70a0878634eea71020d386 (tree) |
---|---|
Time | 2014-07-08 22:43:22 |
Author | Deskull <desull@user...> |
Commiter | Deskull |
Add Doxygen comments to monster2.c.
@@ -1441,7 +1441,7 @@ s16b get_mon_num(int level) | ||
1441 | 1441 | } |
1442 | 1442 | |
1443 | 1443 | |
1444 | -/* | |
1444 | +/*! | |
1445 | 1445 | * @brief モンスターの呼称を作成する / Build a string describing a monster in some way. |
1446 | 1446 | * @param desc 記述出力先の文字列参照ポインタ |
1447 | 1447 | * @param m_ptr モンスターの参照ポインタ |
@@ -1780,7 +1780,7 @@ void monster_desc(char *desc, monster_type *m_ptr, int mode) | ||
1780 | 1780 | |
1781 | 1781 | |
1782 | 1782 | |
1783 | -/* | |
1783 | +/*! | |
1784 | 1784 | * @brief モンスターの調査による思い出補完処理 / Learn about a monster (by "probing" it) |
1785 | 1785 | * @param r_idx 補完されるモンスター種族ID |
1786 | 1786 | * @return 明らかになった情報の度数 |
@@ -1888,9 +1888,13 @@ int lore_do_probe(int r_idx) | ||
1888 | 1888 | } |
1889 | 1889 | |
1890 | 1890 | |
1891 | -/* | |
1892 | - * Take note that the given monster just dropped some treasure | |
1893 | - * | |
1891 | +/*! | |
1892 | + * @brief モンスターの撃破に伴うドロップ情報の保管処理 / Take note that the given monster just dropped some treasure | |
1893 | + * @param m_idx モンスター情報のID | |
1894 | + * @param num_item 手に入れたアイテム数 | |
1895 | + * @param num_gold 手に入れた財宝の単位数 | |
1896 | + * @return なし | |
1897 | + * @details | |
1894 | 1898 | * Note that learning the "GOOD"/"GREAT" flags gives information |
1895 | 1899 | * about the treasure (even when the monster is killed for the first |
1896 | 1900 | * time, such as uniques, and the treasure has not been examined yet). |
@@ -1927,7 +1931,12 @@ void lore_treasure(int m_idx, int num_item, int num_gold) | ||
1927 | 1931 | } |
1928 | 1932 | |
1929 | 1933 | |
1930 | - | |
1934 | +/*! | |
1935 | + * @brief ELDRITCH_HORRORによるプレイヤーの精神破壊処理 | |
1936 | + * @param m_ptr ELDRITCH_HORRORを引き起こしたモンスターの参照ポインタ | |
1937 | + * @param necro 暗黒領域魔法の詠唱失敗によるものならばTRUEを返す | |
1938 | + * @return なし | |
1939 | + */ | |
1931 | 1940 | void sanity_blast(monster_type *m_ptr, bool necro) |
1932 | 1941 | { |
1933 | 1942 | bool happened = FALSE; |
@@ -2167,10 +2176,12 @@ void sanity_blast(monster_type *m_ptr, bool necro) | ||
2167 | 2176 | handle_stuff(); |
2168 | 2177 | } |
2169 | 2178 | |
2170 | - | |
2171 | -/* | |
2172 | - * This function updates the monster record of the given monster | |
2173 | - * | |
2179 | +/*! | |
2180 | + * @brief モンスターの各情報を更新する / This function updates the monster record of the given monster | |
2181 | + * @param m_idx 更新するモンスター情報のID | |
2182 | + * @param full プレイヤーとの距離更新を行うならばtrue | |
2183 | + * @return なし | |
2184 | + * @detail | |
2174 | 2185 | * This involves extracting the distance to the player (if requested), |
2175 | 2186 | * and then checking for visibility (natural, infravision, see-invis, |
2176 | 2187 | * telepathy), updating the monster visibility flag, redrawing (or |
@@ -2615,8 +2626,10 @@ void update_mon(int m_idx, bool full) | ||
2615 | 2626 | } |
2616 | 2627 | |
2617 | 2628 | |
2618 | -/* | |
2619 | - * This function simply updates all the (non-dead) monsters (see above). | |
2629 | +/*! | |
2630 | + * @brief 単純に生存している全モンスターの更新処理を行う / This function simply updates all the (non-dead) monsters (see above). | |
2631 | + * @param full 距離更新を行うならtrue | |
2632 | + * @return なし | |
2620 | 2633 | */ |
2621 | 2634 | void update_monsters(bool full) |
2622 | 2635 | { |
@@ -2636,8 +2649,10 @@ void update_monsters(bool full) | ||
2636 | 2649 | } |
2637 | 2650 | |
2638 | 2651 | |
2639 | -/* | |
2640 | - * Hack -- the index of the summoning monster | |
2652 | +/*! | |
2653 | + * @brief カメレオンの王の変身対象となるモンスターかどうか判定する / Hack -- the index of the summoning monster | |
2654 | + * @param r_idx モンスター種族ID | |
2655 | + * @return 対象にできるならtrueを返す | |
2641 | 2656 | */ |
2642 | 2657 | static bool monster_hook_chameleon_lord(int r_idx) |
2643 | 2658 | { |
@@ -2670,6 +2685,11 @@ static bool monster_hook_chameleon_lord(int r_idx) | ||
2670 | 2685 | return TRUE; |
2671 | 2686 | } |
2672 | 2687 | |
2688 | +/*! | |
2689 | + * @brief カメレオンの変身対象となるモンスターかどうか判定する / Hack -- the index of the summoning monster | |
2690 | + * @param r_idx モンスター種族ID | |
2691 | + * @return 対象にできるならtrueを返す | |
2692 | + */ | |
2673 | 2693 | static bool monster_hook_chameleon(int r_idx) |
2674 | 2694 | { |
2675 | 2695 | monster_race *r_ptr = &r_info[r_idx]; |
@@ -2702,7 +2722,13 @@ static bool monster_hook_chameleon(int r_idx) | ||
2702 | 2722 | return (*(get_monster_hook()))(r_idx); |
2703 | 2723 | } |
2704 | 2724 | |
2705 | - | |
2725 | +/*! | |
2726 | + * @brief モンスターの変身処理 | |
2727 | + * @param m_idx 変身処理を受けるモンスター情報のID | |
2728 | + * @param born 生成時の初変身先指定ならばtrue | |
2729 | + * @param r_idx 旧モンスター種族のID | |
2730 | + * @return なし | |
2731 | + */ | |
2706 | 2732 | void choose_new_monster(int m_idx, bool born, int r_idx) |
2707 | 2733 | { |
2708 | 2734 | int oldmaxhp; |
@@ -2811,8 +2837,10 @@ void choose_new_monster(int m_idx, bool born, int r_idx) | ||
2811 | 2837 | } |
2812 | 2838 | |
2813 | 2839 | |
2814 | -/* | |
2815 | - * Hook for Tanuki | |
2840 | +/*! | |
2841 | + * @brief たぬきの変身対象となるモンスターかどうか判定する / Hook for Tanuki | |
2842 | + * @param r_idx モンスター種族ID | |
2843 | + * @return 対象にできるならtrueを返す | |
2816 | 2844 | */ |
2817 | 2845 | static bool monster_hook_tanuki(int r_idx) |
2818 | 2846 | { |