問題タブ [doxygen]

doxygen が埋め込まれたコメントを取得し、生成されたマニュアルでオプション、変数などのドキュメントを作成できるように、configure.ac をドキュメント化することは可能ですか?

ありがとう

次のコードがあります。

すべて正常に動作しているようです (列挙型はファイル スコープで終了しますが、\file があるため、説明と共に正しくフォーマットされて表示されます。

私が欲しい (そして起こっていない) ことは、Tick_Data_Row::m_cols のドキュメントで Tick_Column_Type への参照をそのドキュメント ページにリンクすることです。通常、Doxygen は「ああ、それは私が知っている名前です。ホットリンクします」と判断するのは非常に賢いようですが、この場合は失敗します。

列挙型を構造体内に移動しても問題ありません。

手がかりはありますか？

コードのさまざまな部分を説明するいくつかの html ページがあり、最近でも Doxygen を実行しました。Doxygen の「関連ページ」ページの下に現在の HTML ページへのリンクを追加したいと考えています。

手動で挿入する以外にこれを行う方法はありますか?

Doxygen を使用してコードのドキュメントを生成しています。これの PDF バージョンを作成する必要があり、Doxygen の LaTeX 出力を使用するのがその方法のようです。

しかし、私は多くの厄介な問題に遭遇しました.LaTeXについて何も知らなかったので、それらにアプローチする方法についてはあまり考えていませんでした.LaTeX関連の数え切れないほどの参考文献はあまり役に立ちません...

sty ファイルでカスタム スタイルのものを作成する方法と、Doxygen でそれを使用する方法を考え出しました。何度も検索した後、これを介してページマージンなどを設定する方法を見つけました。おそらくこれは、他の必要なことを行うために必要なファイルであると推測していますが、doignのコマンドが見つからないようです私が欲しいもの:(

1. 文書の最初の目次には多くの項目が含まれていますが、内容が非常に長くなるため、そうではありませんでした。この内容を、個々の関数や変数などごとに入力するのではなく、最初の 2 つのレベルだけに制限する方法はありますか? ただし、すべてのブックマークを保持したいです。「COMPACT_LATEX」オプションを試してみましたが、目次ページのアイテムを削除するだけでなく、ブックマークと各セクションの最初のメンバーリストも削除しました。これは本当に残しておきたいものです。

2. すべてのメンバーと属性の後ではなく、完全なクラスの説明をセクションの最初に置くなど、物事の順序を変更する方法はありますか?

Doxygenでプリプロセッサ定義を文書化することは可能ですか？変数や関数と同じように実行できると期待していましたが、Doxygenの出力では、定義のドキュメントが「失われた」ようで、定義自体も含まれていません。

私は以下を試しました

と

また、「ファイルスコープ」だけでなく、グループ内に配置してみました（defgroup、addtogroup、ingroupを試しました）が、効果はありませんでした（ただし、グループ内の他の項目は意図したとおりに文書化されていました）。

さまざまなDoxygenオプションを調べましたが、定義の文書化を可能にする（または妨げる）ものは何も見つかりませんでした。

私はグーグルを十分に行ったので、

次のようなダミーの宣言がある場合、Doxygenに「正しい」コラボレーション図を作成させることができます。

私のヘッダーファイルで。

私の質問は、すべてのファイルにその行を実際に含めることなく、すべてのプロジェクトとすべてのヘッダーでそれを機能させるにはどうすればよいですか？

doxygen で生成されたドキュメントから、特定のディレクトリ (およびそのサブディレクトリ) 内のすべてのクラスを表示したいと考えています。

doxygen /addtogroup やその他のグループ コマンドを使用できますが、特定のディレクトリ内の各クラスにグループ タグを追加せずにこれを実行したいと考えています。

SHOW_DIRECTORIES オプションは「ディレクトリ」タブ/パネルを生成しますが、クラスではなく、特定のディレクトリのすべてのファイルを表示します。

どうやってやるの ？

ありがとう！

doxygen スタイルの C++ コメント文字列を解析する Python モジュールを知っている人はいますか? 次のような文字列を意味します (単純な例):

簡単な説明、長い説明、パラメーター、戻り値などを抽出したいと思います。現在、文字列メソッドと正規表現を使用してこれを行っていますが、私のソリューションはあまり堅牢ではありません。あるいは、すぐにセットアップできる使いやすい python パーサー ライブラリを推奨できる人はいますか?

前もって感謝します

Doxygenを使用して、ObjectiveCコードのドキュメントを生成します。しかし今まで、プロパティを正しく文書化する方法についてのガイドラインを見つけることができませんでした。私が見た例は、考えられるあらゆる方法でそれを行います。変数自体を文書化する人もいれば、@property宣言を文書化する人もいます。//を使用するものもあれば、完全な/ ***/ブロックを使用するものもあります。

誰かが私にベストプラクティスのリファレンスを教えてもらえますか？それとも、Doxygenとの将来の互換性に関する情報ですか？少なくとも、公式のパターンを開発すれば、Doxygenに簡単に適応できるパターンに固執したいと思います。

出力の一部としてファイルのSVNからのログを含めるようにDoxygenを構成する方法はありますか？基本的に、コミットを行うときにかなり厳密なログメッセージをSVNに入力します。これらのメッセージには、Doxygen出力内にセクションを含める必要があります。