2

Mavenサイトプラグインを介して、生成するhtml内にJavaDoc構造（クラスなど）へのリンクを自動的に作成する方法があるかどうか疑問に思っています。

私が言っていることの例として、Doxygenはdoxyプロトコルを使用してこれを行う方法を提供します。次のようなアンカーを作成できます。

<a href="doxy://class/ExampleClass">ExampleClass</a>

次に、Doxygenを実行すると、doxy：//参照が、ExampleClassのドキュメントを含む適切なhtmlファイルへの参照に置き換えられます。このように、このクラスまたはそのドキュメントの場所が変更された場合、Doxygenは次のビルドで自動的に変更するため、戻ってリンクを修正することを覚えておく必要はありません。

Mavenサイトは、ナビゲーションバーにJavaDocインデックスへのリンクを生成して提供します。また、JavaDocには、実際のソースコードにリンクするリンクがありますが、ドキュメント内のクラスへの参照を、そのリンクに変換したいと考えていました。クラスのJavaDocは、状況が変わった場合に将来のリリースで最新の状態に保つことを心配する必要はありません。

これは可能ですか？または、ハードコードされたリンクで立ち往生していますか？

前もって感謝します！

4

1 に答える 1

4

私の知る限り、これはDoxia、Mavenで使用されるコンテンツ生成フレームワーク、およびDoxiaモジュールのいずれによってもネイティブにサポートされていません。したがって、リンクを「ハードコーディング」する必要があると思います。

APTを使用する場合、Doxia-1.1（Maven> = 2.1.xで使用）には、元のAPT形式にいくつかの拡張機能が組み込まれていることに注意してください。リンクについて：

Doxia-1.1では、内部リンクと外部リンクに加えて、「ローカル」リンクの概念が導入されました 。[...]

  • ローカルリンクは、同じサイト内の別のドキュメントへのリンクです。ローカルリンクは./、いずれかで始まるか../、内部リンクと区別する必要があります。例えば

    {{{./apidocs/com/company/example/ExampleClass.html}ExampleClass}}

そうは言っても、解決策はDoxiaに含まれているマクロメカニズムを使用することかもしれません。ただし、この機能には独自のマクロを作成する必要があります。ただし、それほど難しいことではありません。ソースリポジトリにある既存のコードを確認してください。

于 2009-10-16T10:40:48.087 に答える