OSDN Git Service

Merge pull request #934 from sikabane-works/feature/add-doxygen-artifact
authorDeskull <61610939+sikabane-works@users.noreply.github.com>
Mon, 26 Apr 2021 11:46:55 +0000 (20:46 +0900)
committerGitHub <noreply@github.com>
Mon, 26 Apr 2021 11:46:55 +0000 (20:46 +0900)
[Add] artifact ディレクトリ以下のファイルに Doxygen コメントを追加. / Add Doxygen comments…

14 files changed:
1  2 
src/artifact/artifact-info.cpp
src/artifact/artifact-info.h
src/artifact/fixed-art-generator.cpp
src/artifact/fixed-art-generator.h
src/artifact/random-art-activation.h
src/artifact/random-art-characteristics.cpp
src/artifact/random-art-characteristics.h
src/artifact/random-art-generator.cpp
src/artifact/random-art-generator.h
src/artifact/random-art-misc.cpp
src/artifact/random-art-misc.h
src/artifact/random-art-pval-investor.h
src/artifact/random-art-resistance.h
src/artifact/random-art-slay.h

Simple merge
@@@ -1,7 -1,11 +1,11 @@@
  #pragma once
+ /*!
+  * @file artifact-info.h
+  * @brief アーティファクトの発動効果取得関数ヘッダ
+  */
  
 -#include "object-enchant/activation-info-table.h"
 -#include "system/angband.h"
 -
 +typedef struct activation_type activation_type;
 +typedef struct object_type object_type;
 +typedef struct player_type player_type;
  int activation_index(player_type *player_ptr, object_type *o_ptr);
  const activation_type *find_activation_info(player_type *player_ptr, object_type *o_ptr);
Simple merge
Simple merge
@@@ -1,4 -1,9 +1,8 @@@
  #pragma once
+ /*!
+  * @file random-art-activation.h
+  * @brief ランダムアーティファクトの発動実装ヘッダ
+  */
  
 -#include "system/angband.h"
 -
 +typedef struct object_type object_type;
  void give_activation_power(object_type *o_ptr);
@@@ -1,7 -1,11 +1,11 @@@
  #pragma once
+ /*!
+  * @file random-art-characteristics.h
+  * @brief ランダムアーティファクトのバイアス付加処理ヘッダ
+  */
  
 -#include "system/angband.h"
 -
 +typedef struct object_type object_type;
 +typedef struct player_type player_type;
  void curse_artifact(player_type *player_ptr, object_type *o_ptr);
  void get_random_name(object_type *o_ptr, char *return_name, bool armour, int power);
  bool has_extreme_damage_rate(player_type *player_ptr, object_type *o_ptr);
Simple merge
@@@ -1,5 -1,9 +1,9 @@@
  #pragma once
+ /*!
+  * @file random-art-generator.h
+  * @brief ランダムアーティファクトの生成メインヘッダ / Artifact code
+  */
  
 -#include "system/angband.h"
 -
 +typedef struct object_type object_type;
 +typedef struct player_type player_type;
  bool become_random_artifact(player_type *player_ptr, object_type *o_ptr, bool a_scroll);
Simple merge
@@@ -1,5 -1,9 +1,9 @@@
  #pragma once
+ /*!
+  * @file random-art-misc.h
+  * @brief ランダムアーティファクト生成のその他特性バイアス付けヘッダ / Artifact code
+  */
  
 -#include "system/angband.h"
 -
 +typedef struct object_type object_type;
 +typedef struct player_type player_type;
  void random_misc(player_type *player_ptr, object_type *o_ptr);
@@@ -1,4 -1,10 +1,8 @@@
  #pragma once
+ /*!
+  * @file random-art-pval-investor.h
+  * @brief ランダムアーティファクトのpval付加処理ヘッダ
+  */
  
 -#include "system/angband.h"
 -
  typedef struct object_type object_type;
  void random_plus(object_type *o_ptr);
@@@ -1,4 -1,9 +1,8 @@@
  #pragma once
+ /*!
+  * @file random-art-resistance.h
+  * @brief ランダムアーティファクトの耐性付加処理ヘッダ
+  */
  
 -#include "system/angband.h"
 -
 +typedef struct object_type object_type;
  void random_resistance(object_type *o_ptr);
@@@ -1,4 -1,9 +1,8 @@@
  #pragma once
+ /*!
+  * @file random-art-slay.h
+  * @brief ランダムアーティファクトのスレイ付加処理ヘッダ
+  */
  
 -#include "system/angband.h"
 -
 +typedef struct object_type object_type;
  void random_slay(object_type *o_ptr);