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. 同じコードベースの新しいファイル名を生成します。
- 3. doxygenを使用したISRドキュメント
- 4. WPFとSilverlightの同じコードベース?
- 5. ジェネリックコレクションを使用してC#プロジェクト用Doxygenを生成
- 6. PHPを使用してCryptoJS.enc.Base64と同じ結果を生成
- 7. CPUとGPUの同じコードベース
- 8. doxygenを使ってマークダウンファイルとして文書を生成する
- 9. Doxygenを使用したDXLドキュメントの生成:関数として表示される場合
- 10. 同じコードベースのモバイルアプリクローン
- 11. Doxygenはスタンドアロン関数のドキュメントを生成しません
- 12. Doxygenを使用してQtドキュメントと似たように生成する方法は?
- 13. MongoドキュメントとJPAエンティティの同じ生成IDを共有
- 14. PHPassを使用して同じパスワードハッシュを生成
- 15. Rationalツールを使用してUMLモデルからドキュメントを生成しますか?
- 16. Doxygenが内部のC#関数のドキュメントを生成していません
- 17. すべてのマシンは、同じシードを使用して同じ乱数の結果を生成しますか?
- 18. Doxygenでpythonスクリプトのドキュメントを生成する
- 19. フルバージョンと同じコードベースのAndroid体験版
- 20. doxygenで同じテキストを複数回使用する
- 21. "Welcome user"と同じページにテキストボックスなし
- 22. doxygenドキュメントのファイル数を減らす
- 23. Doxygenを使用したQt形式のドキュメント?
- 24. Doxygenを使用したC++でのマクロ関数のドキュメント化
- 25. Linuxでdoxygenコマンドを使用してUML図を生成する方法
- 26. Doxygenとnon-Doxygenのコメント付きソースコードを使用した文書作成
- 27. C#NON-Programmerのソース内ドキュメント生成
- 28. 同じエンティティクラスからJSONとXMLを生成するには?
- 29. Sphinx:Sphinxを使用してドキュメントを生成する方法
- 30. Xcode 8.2を使用してHTMLドキュメントを生成する