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

hengband: Commit

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


Commit MetaInfo

Revision343e98b34c123510006d13c7aa5c2b70be965762 (tree)
Time2013-12-28 22:33:30
Authordeskull <deskull@0568...>
Commiterdeskull

Log Message

Add Doxygen comment to birth.c.

Change Summary

Incremental Difference

--- a/src/birth.c
+++ b/src/birth.c
@@ -3586,10 +3586,11 @@ static void init_turn(void)
35863586 }
35873587
35883588
3589-/*
3590- * Try to wield everything wieldable in the inventory.
3591- * Code taken from Angband 3.1.0 under Angband license
3592- */
3589+/*!
3590+ * @brief 所持状態にあるアイテムの中から一部枠の装備可能なものを装備させる。
3591+ * @details アンデッド系種族は開始時刻を夜からにする。
3592+ * @return なし
3593+ */
35933594 static void wield_all(void)
35943595 {
35953596 object_type *o_ptr;
@@ -3651,9 +3652,10 @@ static void wield_all(void)
36513652 }
36523653
36533654
3654-/*
3655- * Each player starts out with a few items, given as tval/sval pairs.
3656- * In addition, he always has some food and a few torches.
3655+/*!
3656+ * プレイヤーの職業毎の初期装備テーブル。/\n
3657+ * Each player starts out with a few items, given as tval/sval pairs.\n
3658+ * In addition, he always has some food and a few torches.\n
36573659 */
36583660 static byte player_init[MAX_CLASS][3][2] =
36593661 {
@@ -3851,9 +3853,10 @@ static byte player_init[MAX_CLASS][3][2] =
38513853 },
38523854 };
38533855
3854-
3855-/*
3856- * Hook function for human corpses
3856+/*!
3857+ * @brief バルログが死体を食べられるモンスターかの判定 / Hook function for human corpses
3858+ * @param r_idx モンスターＩＤ
3859+ * @return 死体を食べられるならTRUEを返す。
38573860 */
38583861 static bool monster_hook_human(int r_idx)
38593862 {
@@ -3866,9 +3869,11 @@ static bool monster_hook_human(int r_idx)
38663869 return FALSE;
38673870 }
38683871
3869-
3870-/*
3871- * Add an outfit object
3872+/*!
3873+ * @brief 初期所持アイテムの処理 / Add an outfit object
3874+ * @detail アイテムを既知のものとした上でwield_all()関数により装備させる。
3875+ * @param o_ptr 処理したいオブジェクト構造体の参照ポインタ
3876+ * @return なし
38723877 */
38733878 static void add_outfit(object_type *o_ptr)
38743879 {
@@ -3886,10 +3891,10 @@ static void add_outfit(object_type *o_ptr)
38863891 }
38873892
38883893
3889-/*
3890- * Init players with some belongings
3891- *
3892- * Having an item makes the player "aware" of its purpose.
3894+/*!
3895+ * @brief 種族/職業/性格などに基づき初期所持アイテムを設定するメインセット関数。 / Init players with some belongings
3896+ * @detail Having an item makes the player "aware" of its purpose.
3897+ * @return なし
38933898 */
38943899 void player_outfit(void)
38953900 {
@@ -4143,9 +4148,9 @@ void player_outfit(void)
41434148 k_info[lookup_kind(TV_POTION, SV_POTION_WATER)].aware = TRUE;
41444149 }
41454150
4146-
4147-/*
4148- * Player race
4151+/*!
4152+ * @brief プレイヤーの種族選択を行う / Player race
4153+ * @return なし
41494154 */
41504155 static bool get_player_race(void)
41514156 {
@@ -4332,8 +4337,9 @@ static bool get_player_race(void)
43324337 }
43334338
43344339
4335-/*
4336- * Player class
4340+/*!
4341+ * @brief プレイヤーの職業選択を行う / Player class
4342+ * @return なし
43374343 */
43384344 static bool get_player_class(void)
43394345 {
@@ -4547,8 +4553,9 @@ static bool get_player_class(void)
45474553 }
45484554
45494555
4550-/*
4551- * Player seikaku
4556+/*!
4557+ * @brief プレイヤーの性格選択を行う / Player Player seikaku
4558+ * @return なし
45524559 */
45534560 static bool get_player_seikaku(void)
45544561 {
@@ -4792,6 +4799,10 @@ static bool get_player_seikaku(void)
47924799 }
47934800
47944801 #ifdef ALLOW_AUTOROLLER
4802+/*!
4803+ * @brief オートローラで得たい能力値の基準を決める。
4804+ * @return なし
4805+ */
47954806 static bool get_stat_limits(void)
47964807 {
47974808 int i, j, m, cs, os;
@@ -5054,6 +5065,10 @@ static bool get_stat_limits(void)
50545065 #endif
50555066
50565067 #ifdef ALLOW_AUTOROLLER
5068+/*!
5069+ * @brief オートローラで得たい年齢、身長、体重、社会的地位の基準を決める。
5070+ * @return なし
5071+ */
50575072 static bool get_chara_limits(void)
50585073 {
50595074 #define MAXITEMS 8
@@ -5363,8 +5378,9 @@ static bool get_chara_limits(void)
53635378 #define HISTPREF_LIMIT 1024
53645379 static char *histpref_buf = NULL;
53655380
5366-/*
5367- * Hook function for reading the histpref.prf file.
5381+/*!
5382+ * @brief 生い立ちメッセージの内容をバッファに加える。 / Hook function for reading the histpref.prf file.
5383+ * @return なし
53685384 */
53695385 void add_history_from_pref_line(cptr t)
53705386 {
@@ -5374,7 +5390,10 @@ void add_history_from_pref_line(cptr t)
53745390 my_strcat(histpref_buf, t, HISTPREF_LIMIT);
53755391 }
53765392
5377-
5393+/*!
5394+ * @brief 生い立ちメッセージをファイルからロードする。
5395+ * @return なし
5396+ */
53785397 static bool do_cmd_histpref(void)
53795398 {
53805399 char buf[80];
@@ -5480,8 +5499,9 @@ static bool do_cmd_histpref(void)
54805499 return TRUE;
54815500 }
54825501
5483-/*
5484- * Character background edit-mode
5502+/*!
5503+ * @brief 生い立ちメッセージを編集する。/Character background edit-mode
5504+ * @return なし
54855505 */
54865506 static void edit_history(void)
54875507 {
@@ -5684,12 +5704,13 @@ static void edit_history(void)
56845704 }
56855705
56865706
5687-/*
5688- * Helper function for 'player_birth()'
5689- *
5707+/*!
5708+ * @brief player_birth()関数のサブセット/Helper function for 'player_birth()'
5709+ * @details
56905710 * The delay may be reduced, but is recommended to keep players
56915711 * from continuously rolling up characters, which can be VERY
56925712 * expensive CPU wise. And it cuts down on player stupidity.
5713+ * @return なし
56935714 */
56945715 static bool player_birth_aux(void)
56955716 {
@@ -6413,9 +6434,9 @@ static bool player_birth_aux(void)
64136434 return (TRUE);
64146435 }
64156436
6416-
6417-/*
6418- * Ask whether the player use Quick Start or not.
6437+/*!
6438+ * @brief クイックスタート処理の問い合わせと実行を行う。/Ask whether the player use Quick Start or not.
6439+ * @return なし
64196440 */
64206441 static bool ask_quick_start(void)
64216442 {
@@ -6499,11 +6520,12 @@ static bool ask_quick_start(void)
64996520 }
65006521
65016522
6502-/*
6503- * Create a new character.
6504- *
6523+/*!
6524+ * @brief プレイヤー作成処理のメインルーチン/ Create a new character.
6525+ * @details
65056526 * Note that we may be called with "junk" leftover in the various
65066527 * fields, so we must be sure to clear them first.
6528+ * @return なし
65076529 */
65086530 void player_birth(void)
65096531 {
@@ -6615,7 +6637,11 @@ void player_birth(void)
66156637 window_flag[2] |= PW_INVEN;
66166638 }
66176639
6618-
6640+/*!
6641+ * @brief プレイヤー作成処理中のステータス表示処理
6642+ * @params fff ファイルポインタ
6643+ * @return なし
6644+ */
66196645 void dump_yourself(FILE *fff)
66206646 {
66216647 char temp[80*10];
Show on old repository browser