From 48fa1ef8c4acb9254ee301fc7c8e1e5413573054 Mon Sep 17 00:00:00 2001
From: deskull <deskull@0568b783-4c39-0410-ac80-bf13821ea2a2>
Date: Thu, 6 Feb 2014 14:06:46 +0000
Subject: [PATCH] Add Doxygen comment to xtra2.c.

---
 src/xtra2.c | 46 ++++++++++++++++++++++++++++++++++------------
 1 file changed, 34 insertions(+), 12 deletions(-)

diff --git a/src/xtra2.c b/src/xtra2.c
index 8b4746c8b..90bf7fc1f 100644
--- a/src/xtra2.c
+++ b/src/xtra2.c
@@ -2311,8 +2311,12 @@ msg_format("%^s
 }
 
 
-/*
+/*!
+ * @brief ¸½ºß¤Î¥³¥ó¥½¡¼¥ëɽ¼¨¤Î½Ä²£¤òÊÖ¤¹¡£ /
  * Get term size and calculate screen size
+ * @param wid_p ¥³¥ó¥½¡¼¥ë¤Îɽ¼¨Éýʸ»ú¿ô¤òÊÖ¤¹
+ * @param hgt_p ¥³¥ó¥½¡¼¥ë¤Îɽ¼¨¹Ô¿ô¤òÊÖ¤¹
+ * @return ¤Ê¤·
  */
 void get_screen_size(int *wid_p, int *hgt_p)
 {
@@ -2323,9 +2327,10 @@ void get_screen_size(int *wid_p, int *hgt_p)
 }
 
 
-/*
- * Calculates current boundaries
- * Called below and from "do_cmd_locate()".
+/*!
+ * @brief ¥³¥ó¥½¡¼¥ë¾å¤Ë¤ª¤±¤ë¥Þ¥Ã¥×ɽ¼¨¤Îº¸¾å°ÌÃÖ¤òÊÖ¤¹ /
+ * Calculates current boundaries Called below and from "do_cmd_locate()".
+ * @return ¤Ê¤·
  */
 void panel_bounds_center(void)
 {
@@ -2341,8 +2346,10 @@ void panel_bounds_center(void)
 }
 
 
-/*
+/*!
+ * @brief ¥³¥ó¥½¡¼¥ë¤Î¥ê¥µ¥¤¥º¤Ë¹ç¤ï¤»¤Æ¥Þ¥Ã¥×¤òºÆÉÁ²è¤¹¤ë /
  * Map resizing whenever the main term changes size
+ * @return ¤Ê¤·
  */
 void resize_map(void)
 {
@@ -2390,8 +2397,10 @@ void resize_map(void)
 	Term_fresh();
 }
 
-/*
+/*!
+ * @brief ¥³¥ó¥½¡¼¥ë¤òºÆÉÁ²è¤¹¤ë /
  * Redraw a term when it is resized
+ * @return ¤Ê¤·
  */
 void redraw_window(void)
 {
@@ -2412,12 +2421,14 @@ void redraw_window(void)
 }
 
 
-/*
+/*!
+ * @brief ¥Õ¥©¡¼¥«¥¹¤òÅö¤Æ¤ë¤Ù¤­¥Þ¥Ã¥×ÉÁ²è¤Î´ð½àºÂɸ¤ò»ØÄꤹ¤ë¡Ê¥µ¥Ö¥ë¡¼¥Á¥ó¡Ë
+ * @param dy Êѹ¹Àè¤Î¥Õ¥í¥¢YºÂɸ
+ * @param dx Êѹ¹Àè¤Î¥Õ¥í¥¢XºÂɸ
  * Handle a request to change the current panel
- *
  * Return TRUE if the panel was changed.
- *
  * Also used in do_cmd_locate
+ * @return ¼ÂºÝ¤ËºÆÉÁ²è¤¬É¬ÍפÀ¤Ã¤¿¾ì¹çTRUE¤òÊÖ¤¹
  */
 bool change_panel(int dy, int dx)
 {
@@ -2466,6 +2477,16 @@ bool change_panel(int dy, int dx)
 	return (FALSE);
 }
 
+/*!
+ * @brief ¥Õ¥©¡¼¥«¥¹¤òÅö¤Æ¤ë¤Ù¤­¥Þ¥Ã¥×ÉÁ²è¤Î´ð½àºÂɸ¤ò»ØÄꤹ¤ë
+ * @param y Êѹ¹Àè¤Î¥Õ¥í¥¢YºÂɸ
+ * @param x Êѹ¹Àè¤Î¥Õ¥í¥¢XºÂɸ
+ * @details
+ * Handle a request to change the current panel
+ * Return TRUE if the panel was changed.
+ * Also used in do_cmd_locate
+ * @return ¼ÂºÝ¤ËºÆÉÁ²è¤¬É¬ÍפÀ¤Ã¤¿¾ì¹çTRUE¤òÊÖ¤¹
+ */
 bool change_panel_xy(int y, int x)
 {
 	int dy = 0, dx = 0;
@@ -2485,13 +2506,14 @@ bool change_panel_xy(int y, int x)
 }
 
 
-/*
+/*!
+ * @brief ¥Þ¥Ã¥×ÉÁ²è¤Î¥Õ¥©¡¼¥«¥¹¤òÅö¤Æ¤ë¤Ù¤­ºÂɸ¤ò¹¹¿·¤¹¤ë
+ * @details
  * Given an row (y) and col (x), this routine detects when a move
  * off the screen has occurred and figures new borders. -RAK-
- *
  * "Update" forces a "full update" to take place.
- *
  * The map is reprinted if necessary, and "TRUE" is returned.
+ * @return ¼ÂºÝ¤ËºÆÉÁ²è¤¬É¬ÍפÀ¤Ã¤¿¾ì¹çTRUE¤òÊÖ¤¹
  */
 void verify_panel(void)
 {
-- 
2.11.0