OSDN Git Service

Add Doxygen comments to header info.
authorDeskull <desull@users.sourceforge.jp>
Sat, 16 Aug 2014 10:22:05 +0000 (19:22 +0900)
committerDeskull <desull@users.sourceforge.jp>
Sat, 16 Aug 2014 10:22:05 +0000 (19:22 +0900)
src/defines.h
src/h-basic.h
src/h-config.h

index fd0a8a9..3bf9df9 100644 (file)
 #define CAVE_MNDK       0x8000    /* Darken by monster */
 
 /* Used only while cave generation */
-#define CAVE_FLOOR      0x0200
+#define CAVE_FLOOR      0x0200 /*!< フロア属性のあるマス */
 #define CAVE_EXTRA      0x0400
 #define CAVE_INNER      0x0800
 #define CAVE_OUTER      0x1000
index 11e91b6..e907196 100644 (file)
@@ -1,14 +1,16 @@
-/* File: h-basic.h */
+/*!
+ * @file h-basic.h
+ * @brief 変愚時追加された基本事項ののヘッダーファイル /
+ * The most basic "include" file. This file simply includes other low level header files.
+ * @date 2014/08/15
+ * @author
+ * 不明(変愚蛮怒スタッフ?)
+ */
+
 
 #ifndef INCLUDED_H_BASIC_H
 #define INCLUDED_H_BASIC_H
 
-/*
- * The most basic "include" file.
- *
- * This file simply includes other low level header files.
- */
-
 #ifdef HAVE_CONFIG_H
 #include "autoconf.h"
 #endif /* HAVE_CONFIG_H */
index 95b301f..1f620ec 100644 (file)
@@ -1,22 +1,25 @@
-/* File: h-config.h */
-
-#ifndef INCLUDED_H_CONFIG_H
-#define INCLUDED_H_CONFIG_H
-
-/*
+/*!
+ * @file h-config.h
+ * @brief 変愚時追加された基本事項ののヘッダーファイル /
+ * The most basic "include" file. This file simply includes other low level header files.
+ * @date 2014/08/15
+ * @author
+ * 不明(変愚蛮怒スタッフ?)
+ * @details
+ * <pre>
  * Choose the hardware, operating system, and compiler.
  * Also, choose various "system level" compilation options.
  * A lot of these definitions take effect in "h-system.h"
- *
  * Note that you may find it simpler to define some of these
  * options in the "Makefile", especially any options describing
  * what "system" is being used.
+ * no system definitions are needed for 4.3BSD, SUN OS, DG/UX
+ * </pre>
  */
 
+#ifndef INCLUDED_H_CONFIG_H
+#define INCLUDED_H_CONFIG_H
 
-/*
- * no system definitions are needed for 4.3BSD, SUN OS, DG/UX
- */
 
 /*
  * OPTION: Compile on a Macintosh (see "A-mac-h" or "A-mac-pch")