OSDN > Find Software > Games/Entertainment > Role-Playing > 変愚蛮怒 > SCM > git > hengband > Commit

変愚蛮怒
Fork
hengband
web

hengband: Commit

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

Add Doxygen comment to birth.c.

--- a/src/birth.c

+++ b/src/birth.c

		@@ -58,19 +58,19 @@ struct hist_type
58	58
59	59
60	60	/*!
61		- * 生い立ちテーブルの定義 / Background information (see below)
62		- *
63		- * Chart progression by race:
64		- * Human --> 1 --> 2 --> 3 --> 50 --> 51 --> 52 --> 53
65		- * Half-Elf --> 4 --> 1 --> 2 --> 3 --> 50 --> 51 --> 52 --> 53
66		- * Elf/High-Elf --> 7 --> 8 --> 9 --> 54 --> 55 --> 56
67		- * Hobbit --> 10 --> 11 --> 3 --> 50 --> 51 --> 52 --> 53
68		- * Gnome --> 13 --> 14 --> 3 --> 50 --> 51 --> 52 --> 53
69		- * Dwarf --> 16 --> 17 --> 18 --> 57 --> 58 --> 59 --> 60 --> 61
70		- * Half-Orc --> 19 --> 20 --> 2 --> 3 --> 50 --> 51 --> 52 --> 53
71		- * Half-Troll --> 22 --> 23 --> 62 --> 63 --> 64 --> 65 --> 66
72		- *
73		- * XXX XXX XXX This table must be correct or drastic errors may occur!
	61	+ * 生い立ちテーブルの定義 / Background information (see below)\n
	62	+ *\n
	63	+ * Chart progression by race:\n
	64	+ * Human --> 1 --> 2 --> 3 --> 50 --> 51 --> 52 --> 53\n
	65	+ * Half-Elf --> 4 --> 1 --> 2 --> 3 --> 50 --> 51 --> 52 --> 53\n
	66	+ * Elf/High-Elf --> 7 --> 8 --> 9 --> 54 --> 55 --> 56\n
	67	+ * Hobbit --> 10 --> 11 --> 3 --> 50 --> 51 --> 52 --> 53\n
	68	+ * Gnome --> 13 --> 14 --> 3 --> 50 --> 51 --> 52 --> 53\n
	69	+ * Dwarf --> 16 --> 17 --> 18 --> 57 --> 58 --> 59 --> 60 --> 61\n
	70	+ * Half-Orc --> 19 --> 20 --> 2 --> 3 --> 50 --> 51 --> 52 --> 53\n
	71	+ * Half-Troll --> 22 --> 23 --> 62 --> 63 --> 64 --> 65 --> 66\n
	72	+ *\n
	73	+ * XXX XXX XXX This table must be correct or drastic errors may occur!\n
74	74	*/
75	75	static hist_type bg[] =
76	76	{

		@@ -2057,18 +2057,23 @@ static struct {
2057	2057	/! オートローラ中、各能力値が水準を超えた回数 / Autoroll matches /
2058	2058	static s32b stat_match[6];
2059	2059
2060		-/1 オートローラの試行回数 / Autoroll round /
	2060	+/! オートローラの試行回数 / Autoroll round /
2061	2061	static s32b auto_round;
2062	2062
	2063	+/*!
	2064	+ * @brief プレイヤー作成を中断して変愚蛮怒を終了する
	2065	+ * @return なし
	2066	+ */
2063	2067	static void birth_quit(void)
2064	2068	{
2065	2069	remove_loc();
2066	2070	quit(NULL);
2067	2071	}
2068	2072
2069		-
2070		-/*
2071		- * Show specific help file
	2073	+/*!
	2074	+ * @brief 指定されたヘルプファイルを表示する / Show specific help file
	2075	+ * @param helpfile ファイル名
	2076	+ * @return なし
2072	2077	*/
2073	2078	static void show_help(cptr helpfile)
2074	2079	{

		@@ -2083,8 +2088,11 @@ static void show_help(cptr helpfile)
2083	2088	}
2084	2089
2085	2090
2086		-/*
2087		- * Choose from one of the available magical realms
	2091	+/*!
	2092	+ * @brief プレイヤーの魔法領域を選択する / Choose from one of the available magical realms
	2093	+ * @param choices 選択可能な魔法領域のビット配列
	2094	+ * @param count 選択可能な魔法領域を返すポインタ群。
	2095	+ * @return 選択した魔法領域のID
2088	2096	*/
2089	2097	static byte choose_realm(s32b choices, int *count)
2090	2098	{

		@@ -2345,8 +2353,9 @@ static byte choose_realm(s32b choices, int *count)
2345	2353	}
2346	2354
2347	2355
2348		-/*
2349		- * Choose the magical realms
	2356	+/*!
	2357	+ * @brief 選択した魔法領域の解説を表示する / Choose the magical realms
	2358	+ * @return ユーザが魔法領域の確定を選んだらTRUEを返す。
2350	2359	*/
2351	2360	static bool get_player_realms(void)
2352	2361	{

		@@ -2480,8 +2489,10 @@ else
2480	2489	}
2481	2490
2482	2491
2483		-/*
2484		- * Save the current data for later
	2492	+/*!
	2493	+ * @brief プレイヤーのクイックスタート情報をプレイヤー構造体から保存する / Save the current data for later
	2494	+ * @param birther_ptr クイックスタート構造体の参照ポインタ
	2495	+ * @return なし。
2485	2496	*/
2486	2497	static void save_prev_data(birther *birther_ptr)
2487	2498	{

		@@ -2529,8 +2540,10 @@ static void save_prev_data(birther *birther_ptr)
2529	2540	}
2530	2541
2531	2542
2532		-/*
2533		- * Load the previous data
	2543	+/*!
	2544	+ * @brief プレイヤーのクイックスタート情報をプレイヤー構造体へ読み込む / Load the previous data
	2545	+ * @param swap TRUEならば現在のプレイヤー構造体上との内容をスワップする形で読み込む。
	2546	+ * @return なし。
2534	2547	*/
2535	2548	static void load_prev_data(bool swap)
2536	2549	{

		@@ -2595,8 +2608,11 @@ static void load_prev_data(bool swap)
2595	2608
2596	2609
2597	2610
2598		-/*
2599		- * Returns adjusted stat -JK- Algorithm by -JWT-
	2611	+/*!
	2612	+ * @brief プレイヤーの能力値表現に基づいて加減算を行う。
	2613	+ * @param value 現在の能力値
	2614	+ * @param amount 加減算する値
	2615	+ * @return 加減算の結果
2600	2616	*/
2601	2617	static int adjust_stat(int value, int amount)
2602	2618	{