OSDN Git Service

Add Doxygen comment to wizard1.c.
authorDeskull <deskull@users.sourceforge.jp>
Mon, 17 Feb 2014 12:59:01 +0000 (21:59 +0900)
committerDeskull <deskull@users.sourceforge.jp>
Mon, 17 Feb 2014 12:59:01 +0000 (21:59 +0900)
src/wizard1.c

index e3a1b2f..fc987c4 100644 (file)
@@ -1,15 +1,15 @@
-/* File: wizard1.c */
-
-/*
+/*!
+ *  @file wizard1.c
+ *  @brief ¥¦¥£¥¶¡¼¥É¥â¡¼¥É¤Î½èÍý(¥¹¥Ý¥¤¥é¡¼½ÐÎÏÃæ¿´) / Spoiler generation -BEN-
+ *  @date 2014/02/17
+ *  @author
  * Copyright (c) 1997 Ben Harrison, and others
- *
  * 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.
+ * 2013 Deskull rearranged comment for Doxygen.
  */
 
-/* Purpose: Spoiler generation -BEN- */
-
 #include "angband.h"
 
 
@@ -23,8 +23,11 @@ static FILE *fff = NULL;
 
 
 
-/*
+/*!
+ * @brief ¥·¥ó¥Ü¥ë¿¦¤Îµ­½Ò̾¤òÊÖ¤¹ /
  * Extract a textual representation of an attribute
+ * @param r_ptr ¥â¥ó¥¹¥¿¡¼¼ï²¤Î¹½Â¤ÂΥݥ¤¥ó¥¿
+ * @return ¥·¥ó¥Ü¥ë¿¦¤Îµ­½Ò̾
  */
 static cptr attr_to_text(monster_race *r_ptr)
 {
@@ -256,8 +259,16 @@ static grouper group_item[] =
 };
 
 
-/*
+/*!
+ * @brief ¥Ù¡¼¥¹¥¢¥¤¥Æ¥à¤Î³Æ¾ðÊó¤òʸ»úÎ󲽤¹¤ë /
  * Describe the kind
+ * @param buf Ì¾¾Î¤òÊÖ¤¹¥Ð¥Ã¥Õ¥¡»²¾È¥Ý¥¤¥ó¥¿
+ * @param dam ¥À¥á¡¼¥¸¥À¥¤¥¹µ­½Ò¤òÊÖ¤¹¥Ð¥Ã¥Õ¥¡»²¾È¥Ý¥¤¥ó¥¿
+ * @param wgt ½ÅÎ̵­½Ò¤òÊÖ¤¹¥Ð¥Ã¥Õ¥¡»²¾È¥Ý¥¤¥ó¥¿
+ * @param lev À¸À®³¬µ­½Ò¤òÊÖ¤¹¥Ð¥Ã¥Õ¥¡»²¾È¥Ý¥¤¥ó¥¿
+ * @param val ²ÁÃͤòÊÖ¤¹¥Ð¥Ã¥Õ¥¡»²¾È¥Ý¥¤¥ó¥¿
+ * @param k ¥Ù¡¼¥¹¥¢¥¤¥Æ¥àID
+ * @return ¤Ê¤·
  */
 static void kind_info(char *buf, char *dam, char *wgt, int *lev, s32b *val, int k)
 {
@@ -349,8 +360,11 @@ static void kind_info(char *buf, char *dam, char *wgt, int *lev, s32b *val, int
 }
 
 
-/*
+/*!
+ * @brief ³Æ¥Ù¡¼¥¹¥¢¥¤¥Æ¥à¤Î¾ðÊó¤ò°ì¹ÔËè¤Ëµ­½Ò¤¹¤ë /
  * Create a spoiler file for items
+ * @param fname ¥Õ¥¡¥¤¥ë̾
+ * @return ¤Ê¤·
  */
 static void spoil_obj_desc(cptr fname)
 {