| Revision | f29912b7aa8b25d9b69614e974f7940ab7bccfef (tree) |
|---|---|
| Time | 2014-01-28 21:20:40 |
| Author | deskull <deskull@0568...> |
| Commiter | deskull |
Add Doxygen comment to files.c.
src/files.c (diff)| @@ -350,69 +350,49 @@ static named_num gf_desc[] = | ||
| 350 | 350 | * Each "action" line has an "action symbol" in the first column, |
| 351 | 351 | * followed by a colon, followed by some command specific info, |
| 352 | 352 | * usually in the form of "tokens" separated by colons or slashes. |
| 353 | - * | |
| 354 | 353 | * Blank lines, lines starting with white space, and lines starting |
| 355 | 354 | * with pound signs ("#") are ignored (as comments). |
| 356 | - * | |
| 357 | 355 | * Note the use of "tokenize()" to allow the use of both colons and |
| 358 | 356 | * slashes as delimeters, while still allowing final tokens which |
| 359 | 357 | * may contain any characters including "delimiters". |
| 360 | - * | |
| 361 | 358 | * Note the use of "strtol()" to allow all "integers" to be encoded |
| 362 | 359 | * in decimal, hexidecimal, or octal form. |
| 363 | - * | |
| 364 | 360 | * Note that "monster zero" is used for the "player" attr/char, "object |
| 365 | 361 | * zero" will be used for the "stack" attr/char, and "feature zero" is |
| 366 | 362 | * used for the "nothing" attr/char. |
| 367 | - * | |
| 368 | 363 | * Parse another file recursively, see below for details |
| 369 | 364 | * %:<filename> |
| 370 | - * | |
| 371 | 365 | * Specify the attr/char values for "monsters" by race index |
| 372 | 366 | * R:<num>:<a>:<c> |
| 373 | - * | |
| 374 | 367 | * Specify the attr/char values for "objects" by kind index |
| 375 | 368 | * K:<num>:<a>:<c> |
| 376 | - * | |
| 377 | 369 | * Specify the attr/char values for "features" by feature index |
| 378 | 370 | * F:<num>:<a>:<c> |
| 379 | - * | |
| 380 | 371 | * Specify the attr/char values for unaware "objects" by kind tval |
| 381 | 372 | * U:<tv>:<a>:<c> |
| 382 | - * | |
| 383 | 373 | * Specify the attr/char values for inventory "objects" by kind tval |
| 384 | 374 | * E:<tv>:<a>:<c> |
| 385 | - * | |
| 386 | 375 | * Define a macro action, given an encoded macro action |
| 387 | 376 | * A:<str> |
| 388 | - * | |
| 389 | 377 | * Create a normal macro, given an encoded macro trigger |
| 390 | 378 | * P:<str> |
| 391 | - * | |
| 392 | 379 | * Create a command macro, given an encoded macro trigger |
| 393 | 380 | * C:<str> |
| 394 | - * | |
| 395 | 381 | * Create a keyset mapping |
| 396 | 382 | * S:<key>:<key>:<dir> |
| 397 | - * | |
| 398 | 383 | * Turn an option off, given its name |
| 399 | 384 | * X:<str> |
| 400 | - * | |
| 401 | 385 | * Turn an option on, given its name |
| 402 | 386 | * Y:<str> |
| 403 | - * | |
| 404 | 387 | * Specify visual information, given an index, and some data |
| 405 | 388 | * V:<num>:<kv>:<rv>:<gv>:<bv> |
| 406 | - * | |
| 407 | 389 | * Specify the set of colors to use when drawing a zapped spell |
| 408 | 390 | * Z:<type>:<str> |
| 409 | - * | |
| 410 | 391 | * Specify a macro trigger template and macro trigger names. |
| 411 | 392 | * T:<template>:<modifier chr>:<modifier name1>:<modifier name2>:... |
| 412 | 393 | * T:<trigger>:<keycode>:<shift-keycode> |
| 413 | 394 | * </pre> |
| 414 | 395 | */ |
| 415 | - | |
| 416 | 396 | errr process_pref_file_command(char *buf) |
| 417 | 397 | { |
| 418 | 398 | int i, j, n1, n2; |
| @@ -810,15 +790,20 @@ errr process_pref_file_command(char *buf) | ||
| 810 | 790 | } |
| 811 | 791 | |
| 812 | 792 | |
| 813 | -/* | |
| 793 | +/*! | |
| 794 | + * @brief process_pref_fileのサブルーチンとして条件分岐処理の解釈と結果を返す / | |
| 814 | 795 | * Helper function for "process_pref_file()" |
| 815 | - * | |
| 796 | + * @param sp テキスト文字列の参照ポインタ | |
| 797 | + * @param fp 再帰中のポインタ参照 | |
| 798 | + * @return | |
| 799 | + * @details | |
| 800 | + * <pre> | |
| 816 | 801 | * Input: |
| 817 | 802 | * v: output buffer array |
| 818 | 803 | * f: final character |
| 819 | - * | |
| 820 | 804 | * Output: |
| 821 | 805 | * result |
| 806 | + * </pre> | |
| 822 | 807 | */ |
| 823 | 808 | cptr process_pref_file_expr(char **sp, char *fp) |
| 824 | 809 | { |
| @@ -1114,8 +1099,20 @@ cptr process_pref_file_expr(char **sp, char *fp) | ||
| 1114 | 1099 | #define PREF_TYPE_AUTOPICK 1 |
| 1115 | 1100 | #define PREF_TYPE_HISTPREF 2 |
| 1116 | 1101 | |
| 1117 | -/* | |
| 1102 | +/*! | |
| 1103 | + * @brief process_pref_fileのサブルーチン / | |
| 1118 | 1104 | * Open the "user pref file" and parse it. |
| 1105 | + * @param name 読み込むファイル名 | |
| 1106 | + * @param preftype prefファイルのタイプ | |
| 1107 | + * @return エラーコード | |
| 1108 | + * @details | |
| 1109 | + * <pre> | |
| 1110 | + * Input: | |
| 1111 | + * v: output buffer array | |
| 1112 | + * f: final character | |
| 1113 | + * Output: | |
| 1114 | + * result | |
| 1115 | + * </pre> | |
| 1119 | 1116 | */ |
| 1120 | 1117 | static errr process_pref_file_aux(cptr name, int preftype) |
| 1121 | 1118 | { |
Fork