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

java - 仅为最新更改创建 javadoc

我正在与IntelliJ IDEA 11一个项目合作。我正在使用 生成javadocmaven-javadoc-plugin但是我只能为整个项目创建 javadoc。

有没有一种方法可以javadoc只为已更改的最新文件分别创建最后一次提交的文件?

0 投票
0 回答
112 浏览

java-8 - Javadoc 链接到拆分包

使用 javadoc 工具(我通过 Maven Javadoc 插件,而不是直接使用 javadoc)时,可以-link选择链接到外部源。现在的问题是我的项目使用了 JSR-305 注释,并且我已将 javadoc 工具配置为链接到 Java SE 8 API。

Java SE 8 API 和 JSR-305 都使用javax.annotation,因此由于 javadoc 无法真正判断javax.annotation.Nullable是来自 Java SE 8 还是来自 JSR-305,它可能会生成指向 Java SE 8 javadocs 的死链接,而不是正常工作的链接链接到 JSR-305 javadocs。有没有办法配置 javadoc 来解决这个问题,例如链接javax.annotation.Nullable到 JSR-305 javadocs 和其他东西,比如javax.annotation.Resource与 Java SE 8 API 对齐?

0 投票
1 回答
726 浏览

java - 阐明报告 - 如何排除少数 API 并包含来自同一类的少数 API

我想从 Enunciate 文档中排除一个类中的几个 API 方法。

有没有办法使用 enunciate 来实现它?

提前致谢

0 投票
1 回答
852 浏览

java - JavaDoc:仅记录用户应该使用的框架中的公共方法?

由于框架的需要,框架通常需要包含具有公共方法的类;使用该框架的用户实际上不应该调用它们。

例如,一个类可能有一个公共构造函数,因此另一个包中的工厂可以实例化它,但用户总是应该使用工厂,而不是直接使用构造函数。

我希望 JavaDoc 只发出关于用户应该调用的那些方法的文档,而不是其他方法。所以在这个例子中,它应该记录工厂方法,而不是公共构造函数。

当然,JavaDoc 本身不知道哪个是哪个,所以我在想“公共”方法可以用一些注解来注解,比如@SupportedAPI,而 JavaDoc 只会吐出关于这些的文档。(这将有一个额外的好处,可以清楚地标记哪些方法有望保持稳定。)

可以配置 JavaDoc 来做到这一点吗?

0 投票
1 回答
1754 浏览

java - Javadoc 私有方法

我开发了自己的 Doclet 来从 Java 类生成 csv。我需要启动这个关于许多项目的 Doclet,我无法编辑 POM 文件。所以我正在使用终端运行:

我需要为 Private 方法生成文档,所以我尝试添加-Dprivate但这不起作用。

有人知道我能做什么吗?

谢谢,伊万。

0 投票
1 回答
35 浏览

maven - 当 detectLinks 为真时,有什么方法可以抑制 Maven Javadoc 插件错误?

如果我为 Maven Javadoc 插件设置属性 detectLinks,则会为不提供 Maven 约定所假设的 apidocs 的依赖项发出一些错误。有没有办法在不将 detectLinks 设置为 false 并明确指定所有 apidocs 链接的情况下抑制此类错误?

仅供参考,我已经为此类工件明确指定了每个 apidocs 位置。因此,如果我可以将它们从自动 apidocs 检测中排除就可以了。

0 投票
0 回答
416 浏览

javadoc - Javadoc 忽略参数注释

我有诸如

Javadoc 按原样创建方法。但是我想@StdString从创建的文档中删除注释。

预期产出

我想忽略源文件中使用的所有自定义注释。有没有办法做到这一点?谢谢你。

0 投票
2 回答
2161 浏览

maven - 如何在 Maven 多模块项目中从 Javadoc 生成中排除单个模块?

我有一个像这样的 Maven 多模块项目:

在调用mvn javadoc:aggregatefoo-parent 时,我想从 Javadoc 生成中排除模块foo-module 。

在我的情况下,使用参数排除包名excludePackageNames不起作用,因为 foo-module 和 foo-module-new 具有相同的包名。

0 投票
0 回答
65 浏览

maven - 仅针对特定目标的 Maven 配置

我发现在使用配置(可能是错误)运行目标maven-javadoc-plugin时不会产生 jar 。我需要一个为我的目标。jardestDirdestDirjavadoc

所以,我只想在目标执行时指定一个destDir配置。有没有办法做到这一点?javadoc

0 投票
1 回答
156 浏览

java - 从命令行设置 javadocExecutable 不起作用

我正在使用 Java 6(最新的公共 Oracle 版本)和 Maven 3.2.5 执行一个项目。我想要使​​用 Java 8 生成的 Javadoc。使用此设置进行配置时,一切正常:

但是,如果我省略该<javadocExecutable>元素并从命令行尝试相同的操作,则会失败(Maven 报告使用 Java 6):