マクロ生成クラスをDoxygenで文書化するには？

Question

私は次のようにクラスを生成するためのマクロを使用します。

generator.h：

class CLASS_NAME : public parent 
{ 
    //generate variables with names given by CLASS_VARIABLES using complicated 
    //Boost.Preprocessor stuff. 
}; 

#undef CLASS_NAME 
#undef CLASS_VARIABLES 

myclass.h：

#define CLASS_NAME MyClass 
#define CLASS_VARIABLES (a, b, c, x, y, z) 
#include "generator.h" 

実際のクラスは、より複雑であり、様々なブーストを使用しています。プリプロセッサマクロ。 generator.hにコメントを追加するか、あるいはドキュメントを使ってサンプルクラスを生成することによって、生成されたクラスをDoxygenで自動的にドキュメント化する方法はありますか？ ENABLE_PREPROCESSINGとMACRO_EXPANSIONを有効にしようとしましたが、これでは十分ではありません。それは動作しませんhttp://www.stack.nl/~dimitri/doxygen/docblocks.html

/*! \class CLASS_NAME 
    \brief An auto generated class 

    A more detailed class description. 
*/ 

/*! \fn CLASS_NAME::CLASS_NAME() 
    \brief Default constuctor 
*/ 

Answer 1

でどのような "他の場所でドキュメント" についてpararaph

Answer 2

。 Doxygenプリプロセッサは完全なファイルのインクルードを実際には実行しません（インクルードされたファイルのみでマクロ定義を調べます;そうでなければ、ENABLE_PREPROCESSINGディレクティブはまったく役に立たないでしょう）。したがって、#include "generator.h"は効果がありません。

#include指示文をインクルードされたファイルの内容で物理的に置き換えると、機能します。 （あまり役に立たない、私は知っている）。

generator.h：

#define DEFCLASS class CLASS_NAME : public parent \ 
{ \ 
    ... whatever ... \ 
}; 

がmyclass.h：

#define CLASS_NAME MyClass 
#define CLASS_VARIABLES (a, b, c, x, y, z) 
#include "generator.h" 
DEFCLASS 

しかし、あなたならば、これは動作しませんこれを行うには

もう一つの方法は、このようなあなたのファイルを変更することですソースファイルごとにDEFCLASSを2回以上使用してください（おそらくDoxygenのバグ/不具合）。

Answer 3

生成されたクラスを別のヘッダーに入れてヘッダーを記録することをおすすめします。最良の場合、生成されたクラスは実装の詳細の詳細です。

もう1つのオプションは、スクリプトのものです。あなたの好きなスクリプト言語を使うか、cheetahのようなものは恐ろしいことではありません。

私はあなたのジェネレータがボイラープレートや特質など何かを簡単に作ることができると推測しています。

GENERATE_CLASS(Foo); 
GENERATE_CLASS(Bar); 

そのような何かはかなり合理的なgrepの飼料です。

Answer 4

私が書いている時点で、Doxygen はになりますが、いくつかの条件が満たされていれば、本格的なファイルが含まれます。 Doxygen internals documentationから：

...プリプロセッサを解析し、それは{ 内部見出さの#includeを除いての#include を（遭遇 ないときは、実際にはコードが含まれています...私は実験を通して発見した他の文書化されていないが、直感的な前提条件がどんなことを{...}の#include自体が文書化されなければならないであるブロックである}ブロック）

。たとえば、Boost.Preprocessorを使用している次のテストファイルでDoxygenを実行すると、コンフィグファイルでMACRO_EXPANSIONが有効で、目的の抽出モードが「すべてのエンティティ」に設定されていれば、構造体FOO::A,FOO::BおよびFOO::Cのエントリが生成され、適切INCLUDE_PATHに設定されている：

#include <boost/preprocessor/iteration/local.hpp> 
#include <boost/preprocessor/tuple/elem.hpp> 

#define STRUCTS (A, B, C) 

namespace FOO { 
    #define BOOST_PP_LOCAL_MACRO(n) struct BOOST_PP_TUPLE_ELEM(3,n, STRUCTS) {}; 
    #define BOOST_PP_LOCAL_LIMITS (0,2) 
    #include BOOST_PP_LOCAL_ITERATE() 
} 

をしかし、なしのドキュメントになります匿名の名前空間に構造体を配置するFOOを取り除きます。したがって、明示的な名前空間内で#include "generator.h"に耐えることができれば、動作します。