2011-08-04 11 views
3

Doxygenを初めて使用しています。私はオープンソースを計画しています。私は本当に、APIのエンドユーザ用のものと、それを変更しようとするもののためのものの2つのドキュメントセットを構築したいと思います。 "user"と "dev"のドキュメントツリーを生成できるようにDoxygenのコメントブロックにタグを付ける方法はありますか?私の問題に対して、より良い解決策がありますか?ありがとう!Doxygenを使用して同じコードベースから "user"と "developer"ドキュメントを生成

答えて

3

コードの構造によっては、それぞれ別々のソースファイルを含む2つのDoxygen設定ファイルを使用することができます。 「ユーザー」設定ファイルはAPIへのパブリックインターフェイスを含むソースファイルのみを一覧表示し、「dev」設定ファイルはプロジェクト全体のすべてのソースファイルを一覧表示します。

これは、すべてのインターフェイス(抽象基本クラスなど)を念頭に置いて文書化する必要があることを意味しますが、定義上、抽象基盤に実装の詳細は存在しないため、通常は問題ありませんクラス。

すべての "dev"ドキュメントは、APIによっては決して見られず、 "user" Doxygen設定ファイルで安全に省略できるインターフェイスを実装する実際のクラスにあります。

もちろん、あなたのコードがこのように構造化されていない場合は、私が考えることができる唯一の解決策は、conditional statementsの束であなたのコメントを記入することです。

0

Malvineousが既に述べたことに加えて、\internal doxygenコマンドがあります。 http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdinternal

\internalあなたはDoxyfileという

にここに詳しい情報をINTERNAL_DOCSを変更することで、ドキュメントの一部を非表示にしたり、表示することができます

関連する問題