问题标签 [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 回答
65 浏览

javadoc - 为不存在的类生成的 Javadoc

该项目由pom.xml具有多个模块的根组成。根包com.example根本不包含任何代码(没有src目录)。每个模块都包含一个包,带有子包,采用典型的 Maven 结构:com.example.foocom.example.barcom.example.bar.baz等。

我的root 中有一个组配置pom.xml

我正在使用命令制作 javadocs mvn clean javadoc:aggregate

生成的 javadocs 按预期对包进行分组,但有一个例外:我还获得了 root package 的 javadocs com.example,位于组Other Packages中,它包含一个类 ,App它的注释为Hello world!。然而,这App并不存在,事实上,在整个代码库中寻找Hello world!零结果。

如何避免生成不存在的类的文档?

已经尝试过:

  • <excludePackageNames>com.example</excludePackageNames>--> 这导致根本没有生成 javadoc,因为它也排除了子包。
0 投票
0 回答
88 浏览

java - Maven Javadoc 插件未找到自定义标记

我创建了一些自定义 JavaDoc Taglets,如下所述:

http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html

当我手动指定 Taglets 类时,它们可以与 Maven Javadoc 插件一起正常工作:

如此处所述:http ://maven.apache.org/plugins/maven-javadoc-plugin/examples/taglet-configuration.html

但是,如果我有插件自动检测我的 Taglets,如上述链接末尾所述,即:

然后,在构建时,我收到以下错误:

有人对检查什么有建议吗?

谢谢!

0 投票
1 回答
1072 浏览

java - Maven-javadoc-plugin 的“聚合”目标和阶段

我有一个多模块项目:

我想为所有模块生成聚合的 Javadoc。这可以通过在parentpom.xml 中使用类似的东西来工作(它有一个pom包装并定义了子模块):

正确生成了聚合的 Javadoc,效果很好!

但问题是我需要将生成的聚合 Javadoc 包含在module3最终的 .jar中!换句话说,我希望结果module3.jar包含生成的所有模块的聚合 Javadoc 的副本!

这就是为什么我尝试在项目的准备包阶段运行maven-javadoc-plugin插件的原因:我希望在打包完成之前生成 Javadoc ,所以我可以包含它(例如,通过使用插件复制它) .parentmodule3maven-antrun-plugin

但是,这是我的问题,似乎即使我使用准备包阶段,当为工件package运行阶段时,还没有生成聚合的 Javadoc !module3就像父插件在所有子插件之后运行一样,即使它是使用应该在之前运行的阶段声明的...

关于如何在阶段之前为所有模块生成聚合 Javadoc 的任何想法,以便我可以包含该 Javadoc?packagemodule3

0 投票
1 回答
1191 浏览

maven - maven-javadoc-plugin sourceFileExcludes 不起作用

我不太确定使用此标签的正确方法是什么,但我这样使用它:

它根本不起作用。maven 中似乎有一个已知错误,因为我发现了这些线程,所以这个标签不起作用: https ://stackoverflow.com/a/26223872/3209177

但那是不久前的事了。我也没有在 Maven 网站上找到太多有用的信息。

那么我们如何在使用 maven 构建 javadoc 时排除某些源文件/类呢?

0 投票
0 回答
87 浏览

java - Javadoc 混合内容被阻止

我为我的项目生成 javadoc,并通过 HTTPS 托管生成的文件。但是当我单击链接以获取外部类的 JavaDoc 时,内容被阻止,因为它位于 HTTP 上(例如,Oracle 类)。因此,在我的 JavaDoc 中对 Object 类的引用如下所示:

http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true

我在 javadoc maven 插件中找不到任何东西来配置它。我可以做些什么来链接到正确的 HTTPS 外部 JavaDoc 页面?

0 投票
5 回答
10962 浏览

java - Maven,javadoc:没有包的源文件

我正在编写一个具有目录结构的 Maven

制作mvn test工作正常。

我的问题是mvn javadoc:javadoc为其中包含的文件生成正确的文档,frtex/src/main/java但发布

这是我的 pom.xml 的相关(?)部分:

project/build/plugins

我应该怎么做才能让 maven/javadoc 找到文件src/main/java/utils

0 投票
4 回答
1805 浏览

java - 如何使 Maven 构建(目标站点)在 Javadoc 警告中失败?

我正在构建我的 Maven 项目,目标是site。输出中有 Javadoc 警告。在这种情况下,我的 Maven 构建必须失败。有没有办法做到这一点?

这是我的 POM 的代码片段(我使用的是 Maven 3.3):

0 投票
1 回答
225 浏览

java - 为 Javadoc 插件指定清单文件

我最近开始使用 Javadocs 并且已经遇到了一个问题:我找不到它的副本。我正在尝试将我自己的 MANIFEST.MF 文件附加到 Javadoc JAR 文件中;不幸的是,这并没有奏效。我已经尝试了几件事(包括使用 maven-jar-plugin 的存档配置),但是这些“解决方案”都没有为我工作。没有抛出任何错误(我已经检查了高级程序参数),而且看起来 Maven 只是将自己的 MANIFEST.MF 文件强制放入 JAR,尽管我明确指示不要这样做。检查控制台中的日志还告诉我 javadoc 插件没有做任何与清单相关的事情。

这是我到目前为止所拥有的:

如果有任何相关性,我正在运行 Apache Maven 3.3.9 和 Apache Ant 1.9.7。

谢谢。

0 投票
2 回答
1198 浏览

java - Java API 核心类的 maven-javadoc-plugin 和 inheritDoc

我正在编写自己的 Java 8 Stream 实现,并希望从原始java.util.stream.Stream接口继承 Javadocs。但是我无法让它工作。生成的 Javadoc 仅显示我的文档,但不显示来自扩展 Stream 接口的文档。

因此,例如,此方法的 javadoc 仅包含文本“一些附加信息”,但不包含来自Stream界面的文档。

这是我对 maven-javadoc-plugin 的配置:

我是否错过了此配置中的某些内容?我在 maven-compiler-plugin 中将sourceand设置target为 1.8。所以根据maven-javadoc-plugin的文档,应该会自动检测到 java API。

Stack Overflow 上也有类似的问题,但那里的答案似乎没有帮助。

0 投票
4 回答
1617 浏览

maven - Maven 搜索 site.xml 缺少的英语语言环境

在使用 maven 构建项目期间,我在更新其父项目的版本后遇到了生成 javadoc 的问题。

如您所见,它尝试下载实际上不存在的 maven_rt_plugin_config-master-2.0.7-site_en .xml 然而,确实存在这样一个没有 _en 后缀的 xml...

据我所知,我没有指定任何语言环境,并且与站点或 javadoc 生成相关的父项目似乎没有任何变化。

为什么 Maven 不回退到默认语言环境?