在配置了maven- site -plugin和maven-javadoc-plugin (使用多克拉瓦多卡)之后,我试图在mvn site生成的站点上获得适当的JavaDocs。在我的代码中,我有几个JUnit测试类(位于src/ test /java/ my /package/*.java),其中JavaDoc注释链接了源代码类(位于src/main/java/my/package/*.java中)。问题是,在生成测试JavaDocs时,javadoc无法找到源类文档所在的位置。我试图通过使用maven- javadoc ( links )的offlineLinks配置选项(记录在这里)来告诉javadoc在哪里可以找到它,但没有成功。我希望javadoc生成相对链接,以便在离线查看生成的文档(从/path/ to /project/target/site/index.html浏览器中浏览)时它们是可行的。我不想禁用测试JavaDocs生成
我的pom.xml x- mvn站点输出的摘录
另外,我是Java和Maven的新手
为了澄清这个问题,下面是一个例子。我在src/test/java/name/earshinov/PrefixCircuits/GenerateATest.java有一个测试类GenerateATest (很抱歉,评论是俄文的):
package name.earshinov.PrefixCircuits;
// imports skipped
/**
* Тестирование алгоритма построения вспомогательных подсетей типа A,
* реализованного в классе {@link name.earshinov.util.PrefixCircuitGenerator},
* по отдельным случаям, описанным в оригинальной статье
*/
public class GenerateATest {
// ...链接类PrefixCircuitGenerator位于src/main/java/name/earshinov/PrefixCircuits/PrefixCircuitGenerator.java.中。运行mvn site之后,在target/site/apidocs/index.html上为源类获取JavaDocs,在target/site/testapidocs/index.html获取testapidocs。在Test JavaDocs中的JavaDocs文档中,我希望看到指向源类JavaDocs中的PrefixCircuitGenerator文档的链接。但是,javadoc找不到我引用的PrefixCircuitGenerator,因此它不会生成链接,相应的警告在mvn site输出中是可见的:
[WARNING] /home/eugene/dev/java/PrefixCircuits-maven/src/test/java/name/earshinov/PrefixCircuits/GenerateATest.java:9: warning 101: Unresolved link/see tag "name.earshinov.util.PrefixCircuitGenerator" in name.earshinov.PrefixCircuits.GenerateATest我的目标是(以某种方式)告诉javadoc如何生成链接。将{@link name.earshinov.PrefixCircuits.PrefixCircuitGenerator}更改为{@link PrefixCircuitGenerator}并不会改变任何事情。
发布于 2011-09-05 22:00:31
只是有时间做实验。似乎doclava doclet不支持外部文档链接(不实现-link命令行选项)。我是通过从CLI运行javadoc来发现的。可能javadoc插件知道-link选项是特定于标准doclet的,因此如果使用替代doclet,它就不会从pom.xml中获取该选项的值并通过命令行参数将其传递给javadoc。因此,不会产生错误。
https://stackoverflow.com/questions/7304132
复制相似问题