问题标签 [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 投票
10 回答
43822 浏览

java - JDK8 - 尝试使用 Maven javadoc 插件生成 javadoc 时出现错误“找不到 javax.interceptor.InterceptorBinding 的类文件”

我正在使用 JDK8(在 Jenkins 启动的 Linux 上使用 Win x64 u25 JDK + 在我的 Eclipse 工作区上进行了尝试 - jdk-8u20-linux-x64,两者都存在同样的问题)。

我有多模块 Maven 项目(我正在从具有包装类型“pom”的主模块启动 Maven 目标“javadoc:aggregate”)。

Pom 构建部分如下所示:

我总是收到错误:

我已经尝试了一切可能,并尝试在谷歌上搜索很长时间,但没有成功。我找到了人们遇到类似问题的链接,但没有任何关于可能解决方案的信息:

http://marc.info/?l=maven-user&m=139615350913286&w=2

http://mail-archives.apache.org/mod_mbox/maven-users/201409.mbox/%3C54101E24.6060304@gmx.de%3E(建议将JDK8更新为>更新20,我这样做了,但问题仍然存在相同)。

任何提示或任何人也经历过这种行为(不幸的是,由于某种原因,它看起来很“罕见”的问题)?对此非常绝望……

0 投票
1 回答
157 浏览

java - 如何自定义 maven-java-doc 插件,只更改 java 源代码部分将在完整生成的 java docfiles 中更新?

我有一个关于 Apache Maven 中的 Maven javadoc 插件的问题。如果安装阶段将被执行,我当前的配置允许为我的 Maven 项目创建一个完整的新 Java 文档。如果我调用命令“mvn clean install”,java doc 文件将被完全删除(为此,我自定义了 Maven clean 插件)。并且在安装阶段,java doc 文件将再次生成!

有没有办法以这种方式自定义 java doc 插件,只有更改的 java 源代码部分才会在现有的 java doc 中更新?并且不会再次生成完整的java doc?

我的 maven-javadoc-配置:

我的 maven-clean-plugin 配置:

0 投票
1 回答
2332 浏览

maven - 在多模块项目中生成聚合 javadoc 时如何避免重复分叉

我正在尝试配置一个 Maven 多模块项目以通过程序集插件生成分发 zip,其中应包括项目中所有子模块的聚合 javadoc。

项目结构是(简化,实际上有大约 20 个模块):

assembly生成分发 zip 的子模块在哪里。根 pom 将所有子模块列为模块,每个子模块的 pom 依次将根 pom 作为其父级。程序集插件绑定到package阶段。所有这一切都很好。

当我尝试创建聚合的 javadoc(不是javadoc jar,而是带有 html 的目录)以包含在程序集中时,就会出现问题。为此,我在根 pom 中将 maven-javadoc-plugin 配置为构建插件,如下所示:

此外,我在程序集子模块中配置了我的程序集描述符,以包含一个带有 javadocs 的文件集,从其父项目的目标目录中挑选:

我在此设置中遇到的问题是:运行时我看到以下输出mvn package

这只是一个片段,但是这些“分叉”消息对于每个子模块重复了很多次(实际上,每个模块大约重复了 60 次)。这让我很担心:看起来好像有很多重复的工作正在进行。让我担心的第二件事是,它显然会下载作为当前反应器一部分的工件的远程快照(请参阅上面片段中的“下载”消息)。我应该指出,尽管有所有这些重复的消息,但目标已经实现:生成了聚合 javadoc,并包含在程序集中。

所以,问题真的是:我做错了什么(如果有的话)?我应该忽略这些重复的“分叉”消息和快照下载,还是表明设置不正确?如果是后者,是否有人知道我应该如何调整设置以使其正常工作?

FWIW 我已经尝试了几种替代配置,包括将 javadoc 插件配置移动到程序集子模块,但都没有给我预期的结果。

我试图保持简短和重点,如果需要更多信息,请告诉我。

顺便说一下,运行 Maven 3.2.3。

0 投票
1 回答
3215 浏览

java - 如何使用 AsciiDoclet 从 .java 文件中的 javadoc 注释生成 asciidoc 文件

我是 asciidoc 的新手。我想从 java 文件中的注释 javadoc(asciidoc 格式)生成 HTML 文档。

例如java文件

我可以从 .ad 文件生成 html 文件,但我不知道如何从 javadoc 生成 .ad(或任何 asciidoc 格式文件)。
所以我想生成 .ad(asciidoc 文件),我用它来使用 asciidoctor-maven-plugin 生成 html 文档。asciidoctor-maven-plugin 将检查 sourceDirectory 中的 .ad 文件并在 outputDirectory 中生成 html 文件。

依赖

引用了 asciidoclet,但我无法获得任何有用的信息。所有示例项目也用于生成 html、pdf、epub 等。
谢谢...

更新
我更改了我的 maven-javadoc-plugin 配置如下并执行mvn org.apache.maven.plugins:maven-javadoc-plugin:2.9:jar,但它生成正常的 html java 文档,它应该生成 .adoc 文件。谁能帮助我我做错了什么?
谢谢...

我正在使用以下依赖项。

0 投票
1 回答
1638 浏览

java - 使用 Maven 将 Javadocs 创建为 zip 文件而不是 jar 文件

我试图弄清楚如何使用 Maven 创建我的 Javadocs 的 zip 文件而不是 jar 文件。我目前正在使用 maven-javadoc-plugin 创建一个 jar 文件。

我查看了此处列出的目标,但没有发现对此有任何帮助。这可以使用 maven-javadoc-plugin 还是必须使用其他插件?

0 投票
1 回答
88 浏览

maven - maven输出中的“<<<”、“>>>”和“---”是什么意思?

这是我项目中的一个代表性示例mvn install

有些行以“<<<”为前缀和后缀,有些带有“>>>”,有些带有“---”。他们的意思是什么?

0 投票
1 回答
441 浏览

java - maven-javadoc-plugin 错误 MJAVADOC-414 是否有解决方法?

在使用 maven-javadoc-plugin 生成测试 Javadoc 时,我突然收到多个错误,指出 Javadoc 插件无法从我的主代码库中找到任何类。在运行test-javadoc目标时,类路径仅包含src/test文件夹中的类;src/main插件没有可见的类。

此错误发生在 maven-javadoc-plugin 版本2.10和. 此错误是官方认可的错误,您可以在此处查看错误报告。官方错误报告列出了涉及将插件降级为 version 的解决方法,我已经确认这是解决错误的成功解决方法。还值得注意的是,该错误目前已被列为已修复,应该在 maven-javadoc-plugin 的下一个版本中消除,这可能是版本2.10.12.10.2MJAVADOC-4142.9.12.11 2.10.3.

但是,我正在尝试找到一种解决方法MJAVADOC-414,它不涉及降级 3 个发行版本的过度杀伤力。有谁知道一种解决方法,可以以不涉及降级的替代方式成功消除有关丢失类引用的错误消息?

0 投票
3 回答
2166 浏览

java - Lombok Maven javadoc:生成源的聚合报告

我有一个用 Maven 构建的多模块 java 项目,我想用javadoc:aggregate. 项目结构如下:

我也在使用Project Lombok在项目中生成一些方法。通过首先使用Lombok maven 插件运行delombok ,我已成功将其配置为与单个模块一起使用。对于单个模块(lomboklib),这将在

然后由maven-javadoc-pluginjavadoc工具处理。这最初是在This SO question中解决的。

如何将javadoc:aggregate报告配置为也使用生成的源?

我已经用Github中的所有模块定义建立了一个问题沙箱。理想情况下,我应该能够运行

在父项目中,编译整个项目并获取整个项目的 javadocs。

0 投票
0 回答
3502 浏览

java - Java 8 + Maven Javadoc 插件:获取 URL 时出错

我正在尝试为我的依赖项生成实际链接到 Javadoc 的 Javadoc。我已经尝试了各种方法来生成 Javadoc,它不会为我的依赖项中的类的引用生成完全限定的类名。我想要带有简化类名的 Java 文档的链接。但是,即使使用 Java API 类名,我也没有得到任何链接并且拥有完全限定的类名。我正在使用 Java 8。我有以下配置:

我在我的 Maven 编译器配置中将源设置为 Java 8。我尝试使用detectJavaApiLinkset totrue并省略指向 Java 8 Javadoc 的链接,但 Javadoc 不会生成指向 Java API 类的链接,并且我的 Javadoc 中对它们的所有引用都是完全限定的类名。

我尝试设置detectJavaApiLinkfalse使用带有指定 URL 的上述配置(不带和不带斜杠),我得到相同的结果,以及此错误:

我已经尝试根据我声明的依赖项检测链接,我尝试将其设置为 false,然后提供指向 Javadoc 的链接,但我仍然没有获得任何链接,并且我的依赖项中的类中的所有类名都是完全限定的。我到底做错了什么?包列表文件在指定的 URL 处可用,所以我不明白为什么 Javadoc 无法访问它们或位于那里的 Javadoc。

更新:

将我的 maven javadoc 插件版本更改为 2.10.3。现在,如果我设置detectJavaApiLinktrue删除 Java 8 javadoc 的链接,javadoc 会正确生成指向 Java API 类的链接并使用简化的名称。

但是,我的第 3 方依赖项和链接到他们的 Javadoc 仍然存在问题。如果我设置detectLinkstrue,它将无法找到其中任何一个的 javadoc。如果我将其设置为false并手动配置位置,我仍然会收到一条错误消息,指出它无法获取 URL:

我为 maven javadoc 插件更新的 pom 配置如下:

更新 2:

向 MJAVADOC 提交的缺陷报告:

https://issues.apache.org/jira/browse/MJAVADOC-427

0 投票
1 回答
279 浏览

apache-camel - 为 OSGi 包生成 Javadoc

我是 OSGi 世界的新手,但我能够做一些 Camel 和 OSGi 包来在中间件中完成一些任务。从那以后我所做的一切都是概念验证,但现在我想重构我的代码的一部分,我开始编写一个 OSGi 包,其中包含在其他 OSGi 包之间共享的通用功能。

为了让它干净,我决定写评论并使用 javadoc 来获得时尚的文档,但我遇到了这个错误:

我能够为另一个 Camel 组件运行 javadoc;

我们有一个本地存储库,其中包含依赖项 maven-javadoc-plugin;

我将依赖项 maven-javadoc-plugin 添加到我的项目中;

我已经没有想法了,为什么它不起作用。

也许我错了,我以错误的方式使用 OSGi 包......

更新