OSDN Git Service

Add Doxygen comments to variables in tables.c.
authorDeskull <desull@users.sourceforge.jp>
Wed, 23 Jul 2014 13:55:08 +0000 (22:55 +0900)
committerDeskull <desull@users.sourceforge.jp>
Wed, 23 Jul 2014 13:55:08 +0000 (22:55 +0900)
src/tables.c

index b4b9e87..1c8bd57 100644 (file)
@@ -1,57 +1,66 @@
-/* File: tables.c */
-
-/*
+/*!
+ * @file tables.c
+ * @brief ゲーム情報テーブル / Angband Tables
+ * @date 2014/07/23
+ * @author
+ * <pre>
  * 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.
+ * </pre>
  */
 
-/* Purpose: Angband Tables */
 
 #include "angband.h"
 
-
-
-
-/*
- * Global array for looping through the "keypad directions"
+/*!
+ * キーパッドの方向を南から反時計回り順に列挙 / Global array for looping through the "keypad directions"
  */
 const s16b ddd[9] =
 { 2, 8, 6, 4, 3, 1, 9, 7, 5 };
 
-/*
- * Global arrays for converting "keypad direction" into offsets
+/*!
+ * dddで定義した順にベクトルのX軸成分を定義 / Global arrays for converting "keypad direction" into offsets
  */
 const s16b ddx[10] =
 { 0, -1, 0, 1, -1, 0, 1, -1, 0, 1 };
 
+/*!
+ * dddで定義した順にベクトルのY軸成分を定義 / Global arrays for converting "keypad direction" into offsets
+ */
 const s16b ddy[10] =
 { 0, 1, 1, 1, 0, 0, 0, -1, -1, -1 };
 
-/*
- * Global arrays for optimizing "ddx[ddd[i]]" and "ddy[ddd[i]]"
+/*!
+ * ddd越しにベクトルのX軸成分を定義 / Global arrays for optimizing "ddx[ddd[i]]" and "ddy[ddd[i]]"
  */
 const s16b ddx_ddd[9] =
 { 0, 0, 1, -1, 1, -1, 1, -1, 0 };
 
+/*!
+ * ddd越しにベクトルのY軸成分を定義 / Global arrays for optimizing "ddx[ddd[i]]" and "ddy[ddd[i]]"
+ */
 const s16b ddy_ddd[9] =
 { 1, -1, 0, 0, 1, 1, -1, -1, 0 };
 
 
-/*
- * Circular keypad direction array
+/*!
+ * キーパッドの円環状方向配列 / Circular keypad direction array
  */
 const s16b cdd[8] =
 { 2, 3, 6, 9, 8, 7, 4, 1 };
 
-/*
- * Global arrays for optimizing "ddx[cdd[i]]" and "ddy[cdd[i]]"
+/*!
+ * cdd越しにベクトルのX軸成分を定義 / Global arrays for optimizing "ddx[cdd[i]]" and "ddy[cdd[i]]"
  */
 const s16b ddx_cdd[8] =
 { 0, 1, 1, 1, 0, -1, -1, -1 };
 
+/*!
+ * cdd越しにベクトルのY軸成分を定義 / Global arrays for optimizing "ddx[cdd[i]]" and "ddy[cdd[i]]"
+ */
 const s16b ddy_cdd[8] =
 { 1, 1, 0, -1, -1, -1, 0, 1 };