問題タブ [doxygen-addtogroup]

名前空間とモジュールを認識する Doxygen に問題があります。\addtogroupを名前空間内に配置するか、名前空間外に配置するかが問題だと思います。

例 1、名前空間の外:

例 2 - 名前空間内

namespace RecordsをDoxygen Namespacesタブの下に表示し、間接的にModulesタブの下に表示したいと思います。Namespacesページのアイテムをクリックすると、を含むページが生成されますRecords::Interface。[モジュール] タブのアイテムをクリックすると、を含むページも生成されますRecords::Interface。

私の Doxygen のドキュメントでは、このジレンマに起因する不一致のために、 モジュールにある名前空間タブに欠落している項目があり、その逆も同様です。

では、例 1 と例 2 のどちらが適切な方法でしょうか。{Doxygen マニュアルは、このトピックについて明確ではありません。}
Doxygen: \addtogroup
Doxygen: 名前空間の文書化

プロジェクト用の Doxygen ドキュメントを作成しています。最近、\addtogroupタグを使用して関連するクラスをグループ化しました。この後、ドキュメントにモジュール タブが追加されました。すべてのモジュールが表示されます。同じページのモジュール名の下のモジュール名のすぐ下に説明を追加したいと思います。Doxygen を使用してそれを行うにはどうすればよいですか?

これが私のタグです

C コードで Doxygen を使用する基本的なヘルプが必要です。基本的なドキュメントはすべて問題なく作成されており、ファイルと関数の長い長いリストを構築するのに助けが必要です。

次のような C ソース ツリーがあります。

非常に標準的です。現在、doxygen はすべてのファイルのフラット ファイル リストを生成します。src/ の各 dub-dir を「モジュール」と呼んでいるため、これを文書化することは Doxygen モジュール/グループに適しているようです。

上記のディレクトリ構造を反映するには、グループ化コマンドをどのように使用すればよいですか? file1 および file2 ドキュメントにリンクする、生成されたドキュメントにモジュール util が必要です。JavaDoc がパッケージを扱うのとまったく同じです。

/addtogroup util & @{ タグを各ヘッダー ファイルに追加すると、すべてのヘッダー内のすべてのデータ構造などのフラット化されたリストを含むミニ サイトが生成されましたが、これは私が期待または望んでいたものではありません。おそらく、これは doxygen グループが行うべきことです。つまり、コードが複数のファイルにまたがって実装されている場合に、API を一様に文書化しますか?

いくつかの定数を持つC++クラスの実装ファイルがあります。定数は、クラスメソッドの実装の前に表示されます。定数をグループ化したい。私のグループと説明は[モジュール]タブに表示されますが、グループはすべて空です。詳細な説明はありますが、グループメンバーはいません。グループは次のようになります。

また、@ addtogroupまたは@ingroupを使用してグループメンバーを明示的に追加しようとしましたが、どちらも機能していないようです。

これが機能しない理由と、それを機能させるために何をする必要があるかについての考えはありますか？

クリスが指摘した編集のタイプミス

解決

これを機能させるには、doxygen構成でEXTRACT_STATIC=YESを設定する必要がありました。

私の C++ アプリケーションには、特定の「動作」を定義する約 10 個の異なるクラスがあります (それらを A、B、C などと呼びましょう)。コード内の他の場所 (メソッド) では、これらの動作を任意に組み合わせて使用​​できます。たとえば、メソッド M1 は動作 A と B を使用し、メソッド M2 は動作 A、C、D を使用します。

実際には、コードは次のようになります。

どのメソッドがビヘイビアーを使用するかについて、できれば特定のビヘイビアーのドキュメントで明確な概要を生成して、すべてのビヘイビアーのクラス ドキュメントに次のようなリストが含まれるようにしたいと考えています。

このリストをハードコードすることもできますが、しばらくすると、新しいメソッドが追加されたり、メソッドが追加の動作を使用し始めたり、メソッドが動作を使用しなくなったりするため、古くなります。したがって、これを保守可能にするために、振る舞いを使用するメソッドに何かを含めることを好み、Doxygen に「このコードはこれらの振る舞いを使用しているので、その振る舞いのドキュメントに何かを追加してください」と伝えます。

「Visual AssistX」や「Understand for C/C++」などのツールを使用するとルックアップを実行できますが、ルックアップを実行するたびに手動操作が必要になります。したがって、ドキュメント生成システムでこれを自動化したいと考えています。

defgroup と ingroup の使用を検討していますが、これがコード フラグメントに対して機能するかどうかはわかりません。使用するための最良のアプローチは何ですか?

iPhone プロジェクトのドキュメントを生成するために Doxygen GUI を使用しようとしています。その中で、「結果を最適化するプログラミング言語を選択する」というオプションがあります。このオプションでは、Objective C オプションが見つかりません。酸素を実行すると、空の HTML ファイルのみが表示されます。

どうか明らかにしてください..！以下はスクリーンショットです...

SOURCE_BROWSER = TRUE を設定すると、すべてのファイルのソース コードが表示されます。

特定のファイルのソースを表示することはできますか?
または、SOURCE_BROWSER = FALSE を使用して \ref または同等の機能を有効にする
SOURCE_BROWSER = TRUE の場合、特定のファイルのソース コードを削除する
または同等の機能

次のように、doxygen のグループにマークダウン ファイルを含めます。

そして、要求に応じてモジュールのドキュメントに表示されます。とにかく、それらは次のように通常のトップレベル ページとして表示されます。

トップレベルのマークダウン ページがモジュール ドキュメント グループに既に含まれている場合、それを削除するにはどうすればよいですか?

私の説明がわかりやすいことを願っています。

Cコードをdoxygenで文書化しています。読みやすくするために、すべての .c/.h ファイルのペア (場合によってはさらに多くのファイル) のドキュメントを と でグループ化しますdefgroup( c: 定義のグループ化 をaddtogroup参照)。ファイル ページは問題ないように見えますが、グループ/モジュール ページでは、すべての変数のドキュメントが 2 倍になっています。ヘッダー ファイルで (extern を使用して) 宣言され、.c ファイルで (概要と説明部分で) 定義されている変数ごとに 2 つのエントリがあります。関数と他のすべてが一度だけリストされます...

グループ/モジュール ページの重複変数ドキュメントを削除するにはどうすればよいですか?

私のソースファイルは次のようになります: .h ファイル:

.c ファイル:

プロジェクトの文書化に Doxygen を使用しています。1 つのファイルに、グループに入れたいパブリック関数がたくさんあります。私は次のようにこれを行います：

問題は、LaTeX 出力にここにあるすべてのドキュメントが 2 回含まれていることです。「モジュール ドキュメント」セクションで 1 回、「ファイル ドキュメント」セクションでもう一度。これは、私の最終的な PDF ファイル (LaTeX から生成されたもの) でおそらく 25 ページの純粋に重複したものに相当します。

理想的な修正は、myFile.c のファイル ドキュメンテーションに「@ref my_group を参照」などと記載することです。Doxygenでこれを達成する方法はありますか?