From 3b21bb4759ec554a892b1e404783d7f068913d2a Mon Sep 17 00:00:00 2001 From: Deskull Date: Sat, 16 Aug 2014 19:22:05 +0900 Subject: [PATCH] Add Doxygen comments to header info. --- src/defines.h | 2 +- src/h-basic.h | 16 +++++++++------- src/h-config.h | 23 +++++++++++++---------- 3 files changed, 23 insertions(+), 18 deletions(-) diff --git a/src/defines.h b/src/defines.h index fd0a8a9ef..3bf9df910 100644 --- a/src/defines.h +++ b/src/defines.h @@ -2592,7 +2592,7 @@ #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 diff --git a/src/h-basic.h b/src/h-basic.h index 11e91b651..e907196d7 100644 --- a/src/h-basic.h +++ b/src/h-basic.h @@ -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 */ diff --git a/src/h-config.h b/src/h-config.h index 95b301f5f..1f620ec9f 100644 --- a/src/h-config.h +++ b/src/h-config.h @@ -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 + *
  * 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
+ * 
*/ +#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") -- 2.11.0