Doxygenを初めて使用しています。私はオープンソースを計画しています。私は本当に、APIのエンドユーザ用のものと、それを変更しようとするもののためのものの2つのドキュメントセットを構築したいと思います。 "user"と "dev"のドキュメントツリーを生成できるようにDoxygenのコメントブロックにタグを付ける方法はありますか?私の問題に対して、より良い解決策がありますか?ありがとう!Doxygenを使用して同じコードベースから "user"と "developer"ドキュメントを生成
3
A
答えて
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
を変更することで、ドキュメントの一部を非表示にしたり、表示することができます
関連する問題
- 1. phonegapとwebに同じコードベースを使用していますか?
- 2. WPFとSilverlightの同じコードベース?
- 3. CPUとGPUの同じコードベース
- 4. ジェネリックコレクションを使用してC#プロジェクト用Doxygenを生成
- 5. doxygenを使ってマークダウンファイルとして文書を生成する
- 6. PHPassを使用して同じパスワードハッシュを生成
- 7. Doxygenを使用してQtドキュメントと似たように生成する方法は?
- 8. Rationalツールを使用してUMLモデルからドキュメントを生成しますか?
- 9. すべてのマシンは、同じシードを使用して同じ乱数の結果を生成しますか?
- 10. フルバージョンと同じコードベースのAndroid体験版
- 11. Entity Framework 6を使用して生成された2つの同じデータベース
- 12. doxygenドキュメントのファイル数を減らす
- 13. Doxygenを使用したQt形式のドキュメント?
- 14. Doxygenを使用したC++でのマクロ関数のドキュメント化
- 15. 同じコードを使用して他のファイルの同じグラフを一度に生成
- 16. capistranoとgitを使用して、同じコードベースを複数のサーバに配備する
- 17. C#NON-Programmerのソース内ドキュメント生成
- 18. タイプ 'Company.Model.User'とタイプ 'Company.Core.Model.User'は同じ単純名 'User'を持ち、同じモデルでは使用できません
- 19. Tomcatを使用して同じPCからの同時ユーザーセッションを防止する
- 20. Java Randomクラスは、同じシードとnextBytes()を使用して重複数を生成しますか?
- 21. Zend Gdataを使用してGoogleドキュメントからドキュメントを削除
- 22. Haddockとスタックを使用して私自身のコードのドキュメントを生成する
- 23. 現在のドキュメントからpdfを生成
- 24. カスタムワークフローとドキュメント生成
- 25. doxygenを使用してクラスページのセクションを作成する
- 26. Doxygenを使用してコメントヘッダPHPファイルを作成するには?
- 27. BoostライブラリのDoxygenドキュメント
- 28. 複数のRails 2.3 Webサイトで同じコードベースを使用して差分を管理する方法
- 29. 使用しているキーボードと同じキーボードレイアウトを作成できますか?
- 30. 複数のAPKが同じコードベースを使用しているため、ユーザーに不便を招く