Doxygen ファイルコメント

[soukouki]

ソースを読む際にもわかりやすいと思うのですが。

[yumetodo]

といいますと？

[soukouki]

ファイルの先頭にそのファイルを説明するコメントを入れれば、 そのファイルの理解の助けになると思ったからです。

[yumetodo]

ああ、そういえばそんなのあったな・・・。

    @file       comment.c
    @brief      ファイルの概要

みたいな感じでしたっけ

[soukouki]

プログラムの全体像も掴みやすくなると思います。

[yumetodo]

では書きますか。ただ私も全部は把握していないし、

53 #54 に関してはmerge前にそれぞれで付ける必要があるだろうから

1. masterの実装中ファイルを別branchに移す
2. masterにあるファイル全てにコメント書く

3. 53 #54 でmasterをmerge、追加ファイルにコメント書く

という流れになると思うんですが、どうでしょう？ @Nagarei

[yumetodo]

今調べたら https://github.com/Nagarei/DxLibEx/blob/b8cb68afbc8b8217f32753cdbddf04c9866becae/dxlibex/dxlib_wrap.hpp はコメントが付いているっぽいな。

/*=============================================================================
  Copyright (C) 2015-2016 DxLibEx project
https://github.com/Nagarei/DxLibEx/

Distributed under the Boost Software License, Version 1.0.
(See http://www.boost.org/LICENSE_1_0.txt)
=============================================================================*/
/**
* \~english  this is thread-safe wrapper of DxLib's functions
* \~japanese DxLibの関数のスレッドセーフなラッパー
* \~
*
* <a href="http://homepage2.nifty.com/natupaji/DxLib/dxfunc.html">ＤＸライブラリ　関数リファレンスページ</a>
*/

#ifndef DXLE_INC_DXLIB_WRAP_HPP_
#define DXLE_INC_DXLIB_WRAP_HPP_
#include "dxlibex/config/no_min_max.h"

試しにdoxygenでdoc吐かせてどんな感じになるのか見てみるか。

[yumetodo]

更新してみたけど http://nagarei.github.io/DxLibEx/ja/html/a00081.html

冒頭のコメントはなんか反映されてないっぽい・・・？

[soukouki]

doxygenの設定ファイルをください。

[yumetodo]

すでに上がっています。./html

[soukouki]

あっ、ありましたか。ありがとうございます。