问题标签 [maven-javadoc-plugin]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
3203 浏览

maven - 如何在 Maven 站点中从 Test JavaDoc 链接源类 JavaDoc?

配置了 maven-site-plugin 和 maven-javadoc-plugin (使用doclava doclet)后,我试图在由mvn site. 在我的代码中,我有几个 JUnit 测试类(位于src/test/java/my/package/*.java),其中 JavaDoc 注释链接源类(位于src/main/java/my/package/*.java) . 问题是在生成 Test JavaDocs 时,javadoc 找不到源类文档所在的位置。我试图通过使用maven-javadoc-plugin 的配置选项来告诉 javadoc 在哪里找到它(links在此处记录offlineLinks),但没有运气。我希望 javadoc 生成相对链接,以便它们在离线查看生成的文档时可用(在浏览器中从/path/to/project/target/site/index.html浏览)。我不想禁用测试 JavaDocs 生成

我的 pom.xml | mvn 站点输出的摘录

另外,我是 Java 和 Maven 新手


为了澄清这个问题,这里有一个例子。我有一个GenerateATest位于src/test/java/name/earshinov/PrefixCircuits/GenerateATest.java的测试类(抱歉评论是俄语):

链接的类PrefixCircuitGenerator位于src/main/java/name/earshinov/PrefixCircuits/PrefixCircuitGenerator.java中。运行后mvn site,我在 target/site/apidocs/index.html 获得源类的 JavaDocs,在target /site/testapidocs/index.html 获得测试 JavaDocs 。在Test JavaDocs 的文档中,我希望看到指向源类 JavaDocs 文档的链接。但是,javadoc 找不到我所指的,因此它不会生成链接,并且相应的警告在输出中可见:GenerateATestPrefixCircuitGeneratorPrefixCircuitGeneratormvn site

我的目标是(以某种方式)告诉 javadoc 如何生成链接。更改{@link name.earshinov.PrefixCircuits.PrefixCircuitGenerator}{@link PrefixCircuitGenerator}不会改变任何内容。

0 投票
5 回答
195261 浏览

java - 如何从命令行禁用 Maven Javadoc 插件?

pom.xml我有这样的声明

有没有办法从命令行关闭它?

我知道我可以将其提取到个人资料中,但这不是我想要的。

0 投票
1 回答
242 浏览

eclipse-rcp - javadoc:aggregate 删除产品目标文件夹

我可以“mvn clean install”在我的产品项目的目标文件夹中生成我的多项目应用程序的 zip 文件。我可以运行“mvn clean javadoc:aggregate”来生成 javadocs。生成两者都没有问题...

当我运行“mvn clean install javadoc:aggregate”时,会创建 javadoc,但会创建和删除产品 zip。

我试图再次运行 mvn 但是:

  • “mvn clean install”生成产品但删除了我的 javadoc 目标文件夹
  • “mvn clean javadoc:aggregate”会生成 javadocs,但会删除我的产品目标文件夹。

可能是什么原因?任何解决方法?

0 投票
5 回答
1705 浏览

java - 使用 Eclipse 编译器而不是 javac 会导致 javadoc 崩溃

概括:

我遇到了一个有趣的问题,我不太确定如何调查它:

  • 我们的项目已经建设好几个月了
  • 我改变了maven-compiler-plugin使用eclipse编译器而不是javac
  • 现在当我跑步时mvn sitemaven-javadoc-plugin失败了
  • 根据堆栈跟踪,Javadoc 工具似乎在 Eclipse 编译器创建的类文件上崩溃

有没有什么办法解决这一问题?如果没有,至少有什么方法可以进一步调试它吗?

完整详情:

我正在使用 Java 1.6.0_27 和 Maven 3.0.2。

我一直在使用 javac 编译器来构建我们的代码库,但我有兴趣尝试 Eclipse 编译器,因为它会产生更好的警告(并且在其他方​​面更具可配置性)。

所以我将maven-compiler-pluginpom.xml 中的定义更改为:

在我的<reporting>部分,我有:

到现在为止还挺好。我做了一个mvn clean install,一切都很好,所有的测试都通过了,一切看起来都很棒。

但是当我尝试运行mvn site时,当它到达 Javadoc 报告时,它失败了,似乎是 Javadoc 崩溃:

我的问题:

好的,那改变了什么?当我使用 javac 时,所有 Javadoc 和 Maven 站点都构建得很好,但是当我切换到 Eclipse 编译器时,Javadoc 崩溃了。

更糟糕的是,它甚至没有告诉我是什么类导致它崩溃,所以我什至不知道从哪里开始调试它。

显然,目前这意味着我不会使用 Eclipse 编译器,而是会坚持使用 javac。但我很好奇为什么会发生这种情况,以及我可以做些什么来修复或解决它。

0 投票
2 回答
2259 浏览

maven - 多模块maven java doc构建

我有这样的多模块Maven项目

我想为所有 java 文件创建 apidocs。如果我在项目根目录中运行 mvn javadoc:aggregate ,它会在项目根目录的目标目录(target/sites/apidocs)中创建 apidcos。但我想要的是为每个二级模块创建这个 apidocs。例如,我希望在 framework1/target/sites/apidocs 中创建 framework1 的所有 java 文件的 apidocs。framework2也是如此。最终结果会是这样

你们能告诉我如何使用 maven javadoc 插件来做到这一点。

编辑:framework1 中的 pom.xml 包含

0 投票
1 回答
1902 浏览

maven - maven 3 javadoc插件忽略配置

我使用 maven 3 并根据新的 maven 3 siteplugin+javadoc 配置配置了我的 javadoc。然而,我所有的 javadoc 配置参数似乎都被忽略了。所以没有包分组,没有源链接等。

我的项目是一个多模块项目,我使用的命令是:mvn3 clean package javadoc:aggregate

这是我的根 pom 的相关部分:

0 投票
1 回答
1665 浏览

maven - maven 3 javadoc 插件不采用 excludepackagename 配置

我正在尝试从 javadoc 站点中排除一堆包。

不幸的是,这个插件似乎过着自己的生活,当它被配置为报告插件时,它access denied在移动文件时失败了,所以它被改为普通插件,然后配置为与站点目标(聚合)一起运行。通过这样做,我们生成了 javadoc,并按原样发布在站点下。

但似乎插件的配置参数根本没有生效。我试图移动<excludePackageNames>元素——既是通用配置,又是聚合目标的特定配置——我什至为我们的整个代码库添加了一个排除项,并且仍然生成了所有文件。

我想要做的是简单地删除几个不应该在 javadoc 中的包。有谁得到这个插件和配置很好玩,排除包?

这是我现在使用的配置,创建了 javadoc,但生成了所有包,包括排除的包。

有什么想法,漂亮吗?

0 投票
1 回答
222 浏览

maven-3 - maven-source-plugin 和 maven-javadoc-plugin 的用途?

我一直在对 maven 源和 javadoc 插件进行一些研究,我想了解一下每个插件的用法。

我从概念上理解插件是如何工作的,以及它们的作用。

我感到困惑的是,为什么您希望将源代码或 javadoc 与您的工件捆绑在一起。执行 site:deploy 时不会发布 javadoc 吗?如果我正在创建一个 JAR 库,该库将用作 eclipse 中另一个项目的依赖项,那么在使用该库中的函数时,附加 javadoc 或源代码使我能够在 eclipse 中查看 javadoc,而如果我未能使用 javadoc 插件,他们将不可用?

什么是“分叉路径”和“jar-no-fork”?它们似乎与此有关。就像我说的那样,我已经做了很多研究,但我无法将它们全部联系在一起。谢谢!

0 投票
2 回答
43970 浏览

maven-3 - 使用 maven 生成 Javadoc HTML?

现在我正在使用 maven-javadoc-plugin 在发布时将 Javadoc 附加到 .jar 工件。

但是,如何以 html 格式生成 Javadoc,以便我们可以将其 scp 到远程服务器以供参考?

谢谢!

0 投票
1 回答
1378 浏览

maven-3 - 使用 maven-javadoc-plugin 和 Maven 3 生成多个 javadoc 报告

我们使用自定义 doclet 从自定义 javadoc 标记生成报告,并使用 Maven 站点插件和 javadoc 插件生成此报告和常规 java API 文档。

POM 的部分如下所示:

在 Maven 2 下,这可以正常工作,但在 Maven 3 中只生成一个报告,这是 POM 中指定的最后一个报告(通过交换reportSet元素来确定)。

经过一些实验,我发现如果我将常规报告的目标从“javadoc”更改为“test-javadoc”,那么我会从两个报告集中获得输出。所以问题似乎是使用 Maven 3 我无法生成两个使用相同 javadoc-plugin 目标的报告。

这是一个错误,还是我错过了一些配置?如http://maven.apache.org/plugins/maven-site-plugin-3.0-beta-3/maven-3.htmlreporting所述,我将 maven-javadoc-plugin 设置从站点插件移至徒劳无功。我正在使用 Maven 3.0.4、maven-site-plugin 3.0-beta-3 和 maven-javadoc-plugin 2.8.1。configuration

谢谢!