2012-03-12 10 views
7

ドキュメントにリンクを作成することを目的としたdoxygenコマンドがいくつかあります(@link@ref)。
現在、@refコマンドを使用して、doxygen(xml)でサポートされていない言語で書かれたカスタムファイルへのリンクを作成しています。
このリンクを変更して、ファイル内の正確な行を指し示したいと思います。
doxygenコマンドがありますか?doxygenのドキュメントファイルの特定の行へのリンクを作成する方法

答えて

6

\refまたは\linkはこれを行うことができません。しかし、可能ならば、リンクを変更せずにリンク先のファイルの内容を変更すると、リンクが無効になるという問題があります。これは、ソースコードとドキュメントを分離する際の問題の1つです。

別のファイルの特定の行にリンクするのではなく、ドキュメントに興味のあるファイルの特定の部分を含めないでください。あなたは、どちらかの可能性:

  • は、スニペットが含ま\includeでファイル全体を含める(\includelinenoもある)と、単なるテキスト(例えば、「次のコード内の関数XXX」)での関連部分を参照、または
  • ファイル内で、\snippetを使用してドキュメントで参照する必要があります。

編集:別の方法として、あなたが一緒に\line\skip\skipline、および\untilコマンドで使用すると、特定のファイルの特定の行/ブロックを含めることができ、\dontincludeコマンドを使用することができます。 \dontincludeのマニュアルの例を参照してください。

+0

ご意見ありがとうございます。 '\ snippet'コマンドは有望に思えましたが、_source files_のコードスニペットでのみ動作し、_xmlリソースfile_からデータを表示したいのです。 doxygenスタイルのコメントが「破損」するため、スニペットの場所を識別するタグをxmlファイルに追加することはできません。 \ includeの使用はスマートですが、それは巨大なファイルであり、毎回それを含めることは望ましくありません(ドキュメントは無関係なデータによって汚されます)。しかし、私のファイルに\ refを使用すると、私はあなたが示唆するように、関連する部分を既に参照しています。私はもっ​​と良い方法を探しています。 – wil

+1

@wil問題ありません。 '\ dontinclude'コマンドの注釈も追加しました。これは、リソースファイルにタグを追加する必要がないため、' \ snippet'コマンドよりも優れています。しかし、ドキュメントによると、このコマンドはソースファイルでしか動作しないようです(私はこれをテストしていないので、実際にはこれが正しいかどうかは分かりません)。 XMLをドキュメントに直接含めることもできます。これに失敗すると、あなたの '\ ref'メソッドを使って生きなければならないかもしれません。 – Chris

+0

'\ dontinclude'コマンドを試してみましたが、xmlファイルでも動作します!私はこの解決策を解決し、あなたの答えを「受け入れられました」ように設定しました:-) – wil

関連する問題