From 6c4b3629ae6f8adc34edd7a41ecce2b240476887 Mon Sep 17 00:00:00 2001 From: deskull Date: Thu, 30 Jan 2014 10:20:02 +0000 Subject: [PATCH] Fix Doxygen comment of files.c. Add Doxygen comment to init1.c. --- src/files.c | 2 +- src/init1.c | 84 ++++++++++++++++++++++++++++++++++++------------------------- 2 files changed, 51 insertions(+), 35 deletions(-) diff --git a/src/files.c b/src/files.c index 92c2182a2..5f56f5744 100644 --- a/src/files.c +++ b/src/files.c @@ -6912,7 +6912,7 @@ static void make_bones(void) bool (*tombstone_aux)(void) = NULL; -/* +/*! * @brief ÊèÀФΥ¢¥¹¥­¡¼¥¢¡¼¥Èɽ¼¨ / * Display a "tomb-stone" * @return ¤Ê¤· diff --git a/src/init1.c b/src/init1.c index f29023441..50a80d582 100644 --- a/src/init1.c +++ b/src/init1.c @@ -1,34 +1,29 @@ -/* File: init1.c */ - -/* - * Copyright (c) 1997 Ben Harrison - * +/*! + * @file init1.c + * @brief ¥²¡¼¥à¥Ç¡¼¥¿½é´ü²½1 / Initialization (part 1) -BEN- + * @date 2014/01/28 + * @author + *
+ * Copyright (c) 1997 Ben Harrison, James E. Wilson, Robert A. Koeneke
  * This software may be copied and distributed for educational, research,
  * and not for profit purposes provided that this copyright and statement
  * are included in all such copies.  Other copyrights may also apply.
- */
-
-/* Purpose: Initialization (part 1) -BEN- */
-
-#include "angband.h"
-
-
-/*
+ * 2014 Deskull rearranged comment for Doxygen.\n
+ * 
+ * @details + *
  * This file is used to initialize various variables and arrays for the
  * Angband game.  Note the use of "fd_read()" and "fd_write()" to bypass
  * the common limitation of "read()" and "write()" to only 32767 bytes
  * at a time.
- *
  * Several of the arrays for Angband are built from "template" files in
  * the "lib/file" directory, from which quick-load binary "image" files
  * are constructed whenever they are not present in the "lib/data"
  * directory, or if those files become obsolete, if we are allowed.
- *
  * Warning -- the "ascii" file parsers use a minor hack to collect the
  * name and text information in a single pass.  Thus, the game will not
  * be able to load any template file with more than 20K of names or 60K
  * of text, even though technically, up to 64K should be legal.
- *
  * Note that if "ALLOW_TEMPLATES" is not defined, then a lot of the code
  * in this file is compiled out, and the game will not run unless valid
  * "binary template files" already exist in "lib/data".  Thus, one can
@@ -36,12 +31,16 @@
  * "*.raw" files in "lib/data", and then quit, and recompile without
  * defining ALLOW_TEMPLATES, which will both save 20K and prevent people
  * from changing the ascii template files in potentially dangerous ways.
- *
  * The code could actually be removed and placed into a "stand-alone"
  * program, but that feels a little silly, especially considering some
  * of the platforms that we currently support.
+ * 
*/ +#include "angband.h" + + + #ifdef ALLOW_TEMPLATES #include "init.h" @@ -49,7 +48,8 @@ /*** Helper arrays for parsing ascii template files ***/ -/* +/*! + * ¥â¥ó¥¹¥¿¡¼¤ÎÂÇ·â¼êÃʥȡ¼¥¯¥ó¤ÎÄêµÁ / * Monster Blow Methods */ static cptr r_info_blow_method[] = @@ -84,7 +84,8 @@ static cptr r_info_blow_method[] = }; -/* +/*! + * ¥â¥ó¥¹¥¿¡¼¤ÎÂÇ·â°À­¥È¡¼¥¯¥ó¤ÎÄêµÁ / * Monster Blow Effects */ static cptr r_info_blow_effect[] = @@ -128,8 +129,8 @@ static cptr r_info_blow_effect[] = NULL }; - -/* +/*! + * ÃÏ·Á°À­¥È¡¼¥¯¥ó¤ÎÄêµÁ / * Feature info flags */ static cptr f_info_flags[] = @@ -253,7 +254,8 @@ static cptr f_info_flags[] = }; -/* +/*! + * ¥â¥ó¥¹¥¿¡¼ÆÃÀ­¥È¡¼¥¯¥ó¤ÎÄêµÁ1 / * Monster race flags */ static cptr r_info_flags1[] = @@ -292,7 +294,8 @@ static cptr r_info_flags1[] = "XXX3" }; -/* +/*! + * ¥â¥ó¥¹¥¿¡¼ÆÃÀ­¥È¡¼¥¯¥ó¤ÎÄêµÁ2 / * Monster race flags */ static cptr r_info_flags2[] = @@ -331,7 +334,8 @@ static cptr r_info_flags2[] = "QUANTUM" }; -/* +/*! + * ¥â¥ó¥¹¥¿¡¼ÆÃÀ­¥È¡¼¥¯¥ó¤ÎÄêµÁ3 / * Monster race flags */ static cptr r_info_flags3[] = @@ -370,7 +374,8 @@ static cptr r_info_flags3[] = "NO_SLEEP" }; -/* +/*! + * ¥â¥ó¥¹¥¿¡¼ÆÃÀ­¥È¡¼¥¯¥ó¤ÎÄêµÁ4 / * Monster race flags */ static cptr r_info_flags4[] = @@ -409,7 +414,8 @@ static cptr r_info_flags4[] = "BR_DISI", }; -/* +/*! + * ¥â¥ó¥¹¥¿¡¼ÆÃÀ­¥È¡¼¥¯¥ó¤ÎÄêµÁ5 / * Monster race flags */ static cptr r_info_flags5[] = @@ -448,7 +454,8 @@ static cptr r_info_flags5[] = "HOLD" }; -/* +/*! + * ¥â¥ó¥¹¥¿¡¼ÆÃÀ­¥È¡¼¥¯¥ó¤ÎÄêµÁ6 / * Monster race flags */ static cptr r_info_flags6[] = @@ -488,7 +495,8 @@ static cptr r_info_flags6[] = }; -/* +/*! + * ¥â¥ó¥¹¥¿¡¼ÆÃÀ­¥È¡¼¥¯¥ó¤ÎÄêµÁ7 / * Monster race flags */ static cptr r_info_flags7[] = @@ -527,7 +535,8 @@ static cptr r_info_flags7[] = "XXX7X31", }; -/* +/*! + * ¥â¥ó¥¹¥¿¡¼ÆÃÀ­¥È¡¼¥¯¥ó¤ÎÄêµÁ8 / * Monster race flags */ static cptr r_info_flags8[] = @@ -567,8 +576,9 @@ static cptr r_info_flags8[] = }; -/* - * Monster race flags - Drops +/*! + * ¥â¥ó¥¹¥¿¡¼ÆÃÀ­¥È¡¼¥¯¥ó¤ÎÄêµÁ9 / + * Monster race flags */ static cptr r_info_flags9[] = { @@ -608,8 +618,9 @@ static cptr r_info_flags9[] = }; -/* - * Monster race flags - Resistances +/*! + * ¥â¥ó¥¹¥¿¡¼ÆÃÀ­¥È¡¼¥¯¥ó¤ÎÄêµÁR(ÂÑÀ­) / + * Monster race flags */ static cptr r_info_flagsr[] = { @@ -648,7 +659,8 @@ static cptr r_info_flagsr[] = }; -/* +/*! + * ¥ª¥Ö¥¸¥§¥¯¥È´ðËÜÆÃÀ­¥È¡¼¥¯¥ó¤ÎÄêµÁ / * Object flags */ static cptr k_info_flags[] = @@ -798,6 +810,10 @@ static cptr k_info_flags[] = "SLOW_REGEN", }; +/*! + * ¥ª¥Ö¥¸¥§¥¯¥ÈÀ¸À®ÆÃÀ­¥È¡¼¥¯¥ó¤ÎÄêµÁ / + * Object flags + */ static cptr k_info_gen_flags[] = { "INSTA_ART", -- 2.11.0