ドキュメントにリンクを作成することを目的としたdoxygenコマンドがいくつかあります(@link、@ref)。
現在、@refコマンドを使用して、doxygen(xml)でサポートされていない言語で書かれたカスタムファイルへのリンクを作成しています。
このリンクを変更して、ファイル内の正確な行を指し示したいと思います。
doxygenコマンドがありますか?doxygenのドキュメントファイルの特定の行へのリンクを作成する方法
7
A
答えて
6
\ref
または\link
はこれを行うことができません。しかし、可能ならば、リンクを変更せずにリンク先のファイルの内容を変更すると、リンクが無効になるという問題があります。これは、ソースコードとドキュメントを分離する際の問題の1つです。
別のファイルの特定の行にリンクするのではなく、ドキュメントに興味のあるファイルの特定の部分を含めないでください。あなたは、どちらかの可能性:
- は、スニペットが含ま
\include
でファイル全体を含める(\includelineno
もある)と、単なるテキスト(例えば、「次のコード内の関数XXX」)での関連部分を参照、または - ファイル内で、
\snippet
を使用してドキュメントで参照する必要があります。
編集:別の方法として、あなたが一緒に\line
、\skip
、\skipline
、および\until
コマンドで使用すると、特定のファイルの特定の行/ブロックを含めることができ、\dontinclude
コマンドを使用することができます。 \dontinclude
のマニュアルの例を参照してください。
関連する問題
- 1. テーブル行に特定のCSSクラスのリンクを作成する
- 2. Doxygenによるイヴァールやメソッドへのリンク
- 3. 1から特定の番号へのリストの作成方法
- 4. 特定のコミットへのプルリクエストの作成方法
- 5. Doxygen:ツリービューで特定のページを非表示にする方法
- 6. 特定のユーザプロファイルへのリンク
- 7. 特定のinodeへのリンク
- 8. 次のページへのリンクを作成する方法(currentpage + 1)
- 9. Android - XMLファイルのデータへのリンクを作成する方法
- 10. mvcで別のウェブサイトへのリンクを作成する方法
- 11. VB.NETの特定の行にリンクするコメントを書く方法
- 12. Qtablewidgetの列に特定の行をリンクする方法
- 13. サイドバーからGoogleシートの特定の行にリンクする方法
- 14. YARD:クラスメソッドへのリンクを作成する方法は?
- 15. ディレクトリへのリンクを作成する方法
- 16. JSPから外部URLへのリンクを作成する方法
- 17. アプリケーションフォルダへのリンクを作成
- 18. を実行し、特定のコード別のページへのリンクが
- 19. 特定の属性値を持つ半径のエージェントへの方向性リンクを作成する
- 20. 特定のブートストラップタブへのリンクをクリック
- 21. 記事のウェブサイトの特定の行にポップアップを作成する方法は?
- 22. 他のページへの要素リンクを作るcssクラスの作成方法
- 23. C#のクラス、メソッド、特に特定のコード行にリンクする方法
- 24. リーフレットマップ上の特定のポイントへのリンク
- 25. Cythonの特定のglibcバージョンへのリンク
- 26. Silverlightアプリケーションの特定のセクションへのリンク
- 27. Rails:特定のユーザーのリンクページへのリンク
- 28. jqueryの特定のタブへのリンク
- 29. レールの特定のajaxタブへのリンク
- 30. データベースへのリンクを作成する
ご意見ありがとうございます。 '\ snippet'コマンドは有望に思えましたが、_source files_のコードスニペットでのみ動作し、_xmlリソースfile_からデータを表示したいのです。 doxygenスタイルのコメントが「破損」するため、スニペットの場所を識別するタグをxmlファイルに追加することはできません。 \ includeの使用はスマートですが、それは巨大なファイルであり、毎回それを含めることは望ましくありません(ドキュメントは無関係なデータによって汚されます)。しかし、私のファイルに\ refを使用すると、私はあなたが示唆するように、関連する部分を既に参照しています。私はもっと良い方法を探しています。 – wil
@wil問題ありません。 '\ dontinclude'コマンドの注釈も追加しました。これは、リソースファイルにタグを追加する必要がないため、' \ snippet'コマンドよりも優れています。しかし、ドキュメントによると、このコマンドはソースファイルでしか動作しないようです(私はこれをテストしていないので、実際にはこれが正しいかどうかは分かりません)。 XMLをドキュメントに直接含めることもできます。これに失敗すると、あなたの '\ ref'メソッドを使って生きなければならないかもしれません。 – Chris
'\ dontinclude'コマンドを試してみましたが、xmlファイルでも動作します!私はこの解決策を解決し、あなたの答えを「受け入れられました」ように設定しました:-) – wil