OSDN Git Service

Add Doxygen comment to files.c.
authordeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Wed, 29 Jan 2014 12:53:29 +0000 (12:53 +0000)
committerdeskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Wed, 29 Jan 2014 12:53:29 +0000 (12:53 +0000)
src/files.c

index 4a0334d..1fe8a6a 100644 (file)
@@ -6248,8 +6248,11 @@ prt("[
 }
 
 
-/*
+/*!
+ * @brief ¥Ø¥ë¥×¤òɽ¼¨¤¹¤ë¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó
  * Peruse the On-Line-Help
+ * @return ¤Ê¤·
+ * @details
  */
 void do_cmd_help(void)
 {
@@ -6269,8 +6272,12 @@ void do_cmd_help(void)
 }
 
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î̾Á°¤ò¥Á¥§¥Ã¥¯¤·¤Æ½¤Àµ¤¹¤ë
  * Process the player name.
+ * @param sf ¥»¡¼¥Ö¥Õ¥¡¥¤¥ë̾¤Ë¹ç¤ï¤»¤¿½¤Àµ¤ò¹Ô¤¦¤Ê¤é¤ÐTRUE
+ * @return ¤Ê¤·
+ * @details
  * Extract a clean "base name".
  * Build the savefile name if needed.
  */
@@ -6452,15 +6459,17 @@ quit_fmt("'%s' 
 }
 
 
-/*
+/*!
+ * @brief ¥×¥ì¥¤¥ä¡¼¤Î̾Á°¤òÊѹ¹¤¹¤ë¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó
  * Gets a name for the character, reacting to name changes.
- *
+ * @return ¤Ê¤·
+ * @details
+ * <pre>
  * Assumes that "display_player(0)" has just been called
- *
  * Perhaps we should NOT ask for a name (at "birth()") on
  * Unix machines?  XXX XXX
- *
  * What a horrible name for a global function.  XXX XXX XXX
+ * </pre>
  */
 void get_name(void)
 {
@@ -6505,8 +6514,11 @@ void get_name(void)
 
 
 
-/*
+/*!
+ * @brief ¼«»¦¤¹¤ë¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó
  * Hack -- commit suicide
+ * @return ¤Ê¤·
+ * @details
  */
 void do_cmd_suicide(void)
 {
@@ -6615,9 +6627,12 @@ prt("
 }
 
 
-
-/*
+/*!
+ * @brief ¥»¡¼¥Ö¤¹¤ë¥³¥Þ¥ó¥É¤Î¥á¥¤¥ó¥ë¡¼¥Á¥ó
  * Save the game
+ * @param is_autosave ¥ª¡¼¥È¥»¡¼¥ÖÃæ¤Î½èÍý¤Ê¤é¤ÐTRUE
+ * @return ¤Ê¤·
+ * @details
  */
 void do_cmd_save_game(int is_autosave)
 {