2

我想知道是否有办法通过 maven 站点插件让它在它生成的 html 中自动创建指向某些 JavaDoc 结构（如类）的链接。

作为我的意思的一个例子，Doxygen 提供了一种通过使用 doxy 协议来做到这一点的方法。您可以像这样创建锚点：

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

然后，当您运行 Doxygen 时，它会将 doxy:// 引用替换为对包含 ExampleClass 文档的适当 html 文件的引用。这样，如果这个类或其文档的位置发生了变化，我就不需要记住返回并修复链接，因为 Doxygen 会在下一次构建时自动更改它。

Maven Site 在导航栏中生成并提供指向 JavaDoc 索引的链接，并且 JavaDoc 中有链接到实际源代码的链接，但我希望将我对文档中类的任何引用转换为指向该链接的链接class 的 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 回答