変愚蛮怒のメインリポジトリです
Revision | 01bb8afba622cc4aad3f4d14fbbc67c08ac16c92 (tree) |
---|---|
Time | 2014-08-15 21:35:33 |
Author | Deskull <desull@user...> |
Commiter | Deskull |
Add Doxygen comments to definitions for cave arguments in grid.h.
@@ -1,18 +1,17 @@ | ||
1 | -/* | |
2 | - * File: grid.h | |
1 | +/*! | |
2 | + * @file grid.h | |
3 | + * @brief ダンジョンの生成処理の基幹部分ヘッダーファイル | |
4 | + * @date 2014/08/15 | |
5 | + * @details | |
3 | 6 | * Purpose: header file for grid.c, used only in dungeon generation |
4 | 7 | * files (generate.c, rooms.c) |
5 | - */ | |
6 | - | |
7 | -/* | |
8 | + * @author | |
8 | 9 | * Copyright (c) 1989 James E. Wilson, Robert A. Koeneke |
9 | - * | |
10 | 10 | * This software may be copied and distributed for educational, research, and |
11 | 11 | * not for profit purposes provided that this copyright and statement are |
12 | 12 | * included in all such copies. |
13 | 13 | */ |
14 | 14 | |
15 | - | |
16 | 15 | /* Macros */ |
17 | 16 | |
18 | 17 | #define set_cave_feat(Y,X,F) (cave[(Y)][(X)].feat = (F)) |
@@ -21,12 +20,39 @@ | ||
21 | 20 | /* This should not be used */ |
22 | 21 | /*#define set_cave_info(Y,X,I) (cave[(Y)][(X)].info = (I)) */ |
23 | 22 | |
23 | +/*! | |
24 | + * @brief 指定座標が瓦礫かどうかを返す | |
25 | + * @param Y 指定Y座標 | |
26 | + * @param X 指定X座標 | |
27 | + * @return 瓦礫ならばTRUE | |
28 | + */ | |
24 | 29 | #define place_rubble(Y,X) set_cave_feat(Y,X,feat_rubble) |
30 | + | |
31 | +/*! | |
32 | + * @brief 指定座標が上り階段かどうかを返す | |
33 | + * @param Y 指定Y座標 | |
34 | + * @param X 指定X座標 | |
35 | + * @return 上り階段ならばTRUE | |
36 | + */ | |
25 | 37 | #define place_up_stairs(Y,X) set_cave_feat(Y,X,feat_up_stair) |
38 | + | |
39 | +/*! | |
40 | + * @brief 指定座標が下り階段かどうかを返す | |
41 | + * @param Y 指定Y座標 | |
42 | + * @param X 指定X座標 | |
43 | + * @return 下り階段ならばTRUE | |
44 | + */ | |
26 | 45 | #define place_down_stairs(Y,X) set_cave_feat(Y,X,feat_down_stair) |
27 | 46 | |
47 | +/*! | |
48 | + * @brief 指定座標がFLOOR属性を持ったマスかどうかを返す | |
49 | + * @param Y 指定Y座標 | |
50 | + * @param X 指定X座標 | |
51 | + * @return FLOOR属性を持っているならばTRUE | |
52 | + */ | |
28 | 53 | #define is_floor_bold(Y,X) (cave[Y][X].info & CAVE_FLOOR) |
29 | 54 | #define is_extra_bold(Y,X) (cave[Y][X].info & CAVE_EXTRA) |
55 | + | |
30 | 56 | #define is_inner_bold(Y,X) (cave[Y][X].info & CAVE_INNER) |
31 | 57 | #define is_outer_bold(Y,X) (cave[Y][X].info & CAVE_OUTER) |
32 | 58 | #define is_solid_bold(Y,X) (cave[Y][X].info & CAVE_SOLID) |