OSDN Git Service

Add Doxygen header comment to h-define.h.
authorDeskull <desull@users.sourceforge.jp>
Sat, 16 Aug 2014 11:50:53 +0000 (20:50 +0900)
committerDeskull <desull@users.sourceforge.jp>
Sat, 16 Aug 2014 11:50:53 +0000 (20:50 +0900)
src/h-config.h
src/h-define.h

index 1f620ec..535e36e 100644 (file)
@@ -1,6 +1,6 @@
 /*!
  * @file h-config.h
- * @brief å¤\89æ\84\9aæ\99\82追å\8a ã\81\95ã\82\8cã\81\9få\9fºæ\9c¬äº\8bé \85ã\81®ã\81®ã\83\98ã\83\83ã\83\80ã\83¼ã\83\95ã\82¡ã\82¤ã\83« /
+ * @brief 変愚時追加された基本事項のヘッダーファイル /
  * The most basic "include" file. This file simply includes other low level header files.
  * @date 2014/08/15
  * @author
index 343bda3..b992107 100644 (file)
@@ -1,21 +1,22 @@
-/* File: h-define.h */
+/*!
+ * @file h-define.h
+ * @brief 変愚蛮怒で新しく追加された主要なマクロ定義ヘッダ / Define some simple constants
+ * @date 2014/08/16
+ * @author
+ * 不明(変愚蛮怒開発チーム?)
+ */
 
 #ifndef INCLUDED_H_DEFINE_H
 #define INCLUDED_H_DEFINE_H
 
 /*
- * Define some simple constants
- */
-
-
-/*
  * Hack -- Define NULL
  */
 #ifndef NULL
 # ifdef __STDC__
-#  define NULL ((void*)0)
+#  define NULL ((void*)0) /*!< コンパイル環境に定義がない場合のNULL定義 */
 # else
-#  define NULL ((char*)0)
+#  define NULL ((char*)0) /*!< コンパイル環境に定義がない場合のNULL定義 */
 # endif /* __STDC__ */
 #endif /* NULL */
 
  */
 
 #undef TRUE
-#define TRUE   1
+#define TRUE   1 /*!< コンパイル環境に定義がない場合のTRUE定義 */
 
 #undef FALSE
-#define FALSE  0
+#define FALSE  0 /*!< コンパイル環境に定義がない場合のFALSE定義 */
 
 
 
 /**** Simple "Macros" ****/
 
 #ifdef ZANGBAND_JP
-#define lbtokg(x) ((int)(((x)*4536)/1000))
-#define lbtokg1(x) ((lbtokg(x)+5)/100)
-#define lbtokg2(x) ( ( (lbtokg(x)+5)%100)/10) 
+#define lbtokg(x) ((int)(((x)*4536)/1000)) /*!< Zangband基準のポンド→キログラム変換定義(全体) */
+#define lbtokg1(x) ((lbtokg(x)+5)/100) /*!< Zangband基準のポンド→キログラム変換定義(整数部) */
+#define lbtokg2(x) ( ( (lbtokg(x)+5)%100)/10)  /*!< Zangband基準のポンド→キログラム変換定義(少数部) */
 #elif defined(JP)
-#define lbtokg(x) ((int)((x)*5))
-#define lbtokg1(x) (lbtokg(x)/100)
-#define lbtokg2(x) ((lbtokg(x)%100)/10) 
+#define lbtokg(x) ((int)((x)*5)) /*!< 変愚蛮怒基準のポンド→キログラム変換定義(全体) */
+#define lbtokg1(x) (lbtokg(x)/100) /*!< 変愚蛮怒基準のポンド→キログラム変換定義(整数部) */
+#define lbtokg2(x) ((lbtokg(x)%100)/10)  /*!< 変愚蛮怒基準のポンド→キログラム変換定義(少数部) */
 #endif
+
 /*
  * Force a character to lowercase/uppercase
  */