问题标签 [maven-javadoc-plugin]

我有一个大问题。那就是我使用的是 NetBeans 7.1.2，它永远不会立即向我显示 JavaDoc，当我键入一些方法时，它会在互联网上搜索 JavaDoc，说“正在下载 JavaDoc”。然后只显示该方法的 JavaDoc。我什至尝试手动下载 JavaDoc 并将其设置为 netbeans，但仍然不行。下面的图片将清楚地解释这个问题。

这里，JavaDoc 正在下载 这里，JavaDoc 是手动添加的

我的 Maven javadoc 插件现在运行良好，但我不知道如何通过 scp 将它添加到远程目录。

如何通过 scp 传输 javadoc 文件，但在它们生成之后？当我调用 site:site 时，这会自动发生吗？

谢谢！

我的团队正在使用功能分支来实现新功能，并不断将快照构建部署到远程存储库中供我们的用户使用。因此，“部署”实际上只意味着“分发到远程 Maven 存储库”。我们目前只为 master 分支而不是 feature 分支运行持续集成构建，原因如下：我们使用 Maven 构建我们的项目并将 JavaDoc 和源代码与 JAR 一起分发。

我现在的计划是为每个功能分支构建添加一个分类器，并希望在创建和部署这样的工件时使用一个分类器：

• 分支：主
• 分类： 无

• 工件：foo-${version}.jar、foo-${version}-sources.jar、foo-${version}-javadoc.jar

• 分支：特征-X

• 分类： myfeature
• 文物：foo-${version}-feature.jar, foo-${version}-sources-feature.jar,foo-${version}-javadoc-feature.jar

我并不关心工件的确切命名，我只需要功能分支的单独的主、源和 JavaDoc 工件。事实证明，JavaDoc 插件和源插件都没有考虑配置分类器，因此有效地覆盖了为我的主构建创建的工件。

我真的不想更改 artifactId，尽管这可能会解决问题。您如何处理功能分支和与 Maven 的持续集成？

请注意，我已经编写了“Java 文档”，因为我不一定期望 javadoc 实用程序能够实现我所追求的（更不用说我正在使用的 maven-javadoc-plugin）。

我需要生成一个文档站点，其中仅包含扩展/实现特定接口的类，不幸的是，这些类似乎没有安排在逻辑包结构中，允许我通过过滤包路径来做到这一点。

有什么建议么？

我正在尝试编译 JavaDocs：

我不断收到错误，例如：

和

显然，我对多模块/聚合项目的依赖项没有被识别。pom.xml在我的一个模块文件中，这两个都被标记为依赖项。我是否需要maven-javadoc-plugin在父 pom.xml 中提供额外的参数？

编辑：

我跑了mvn install，它似乎奏效了。我的父母pom.xml是：

该版本已过时，但这似乎不是问题。

问题

我正在运行mvn javadoc:javadoc以生成 JavaDoc，我对结果感到满意，除了一件事：它为来自第三方库或我们自己的代码库的任何类提供了完全限定的类名。例如，

它为返回这些类之一的方法提供了com.project.beans.BeanA和com.project.beans.BeanB的返回类型。

它为采用 JSON 对象的方法提供了org.codehaus.jettison.json.JSONObject的参数类型。（而它为采用 java.lang.Integer 的方法提供了 Integer 的参数类型。）

问题

为了便于阅读，有没有办法为这些类生成简写名称？即 BeanA、BeanB、JSONObject。

有没有办法在没有任何 XML 配置的情况下做到这一点？

提前致谢 ：-）

我有一个应用程序，其各种组件分布在大约 100 个 git 存储库中。它们都是独立的 maven 项目（当然，它们之间存在依赖关系），我通过为应用程序捆绑所有它们来创建一个 .war。

我想创建尽可能完全相互关联的javadocs（任何提及来自不同maven项目的类型都超链接到它的javadoc页面）。Maven javadoc 插件似乎不允许这样做。是否有 Maven 配置/我可以做到这一点的任何其他方式？

谢谢，阿曼

我正在尝试在我的多模块 Maven 项目中为 JavaDocs 配置备用输出位置。我将父 POM 中的 maven-javadoc 配置为如下所示：

然后这里是我设置 project.reporting.outputDirectory 的地方。

但是，Maven 似乎并不关心上述配置，尽管如此，它仍在默认目录中输出 JavaDoc。为什么是这样？

此外，我为我的 project.reporting.outputDirectory 变量使用了相对路径。当我mvn javadoc:javadoc在子模块中运行时，这个相对路径的含义是否与我在父模块中运行时的含义相同？

在此先感谢...非常感谢！

我想为多模块 maven 项目中的所有模块设置一个备用 JavaDoc 位置。不幸的是，我不得不依赖相对路径，或者使用像 ${basedir} 这样的 maven 属性，因为这是一个关于颠覆的团队项目，没有绝对路径对我们所有人来说都是相同的。

做这个的最好方式是什么？如果我有一个项目结构

我想将 API 放在 sub3/docs 中，那么当父模块识别出与子模块不同的路径时，如何将所有模块指向 sub3/docs 中的输出 HTML 文件？

提前致谢。

我试图在编译时将所有类 javadoc 注释（最好是库 WebPage 类的子类）转储到格式为 .properties 的文件中classname=comment。

到目前为止，我有：

• 创建 doclet 类SiteMapDoclet
  • 该类被定义为扫描项目中的所有 javadocs 并将它们转储到 .properties 文件中
• 将必要的配置添加到我的 pom.xml 以使其正常工作。

版本： Java 1.6.0.21、Maven 2.2.1

问题：
mvn site返回：

我尝试将 jar 设置为AdditionalDependencies即使它们是我的项目的正常依赖项。我还尝试将路径添加到我希望我的类需要作为引导类路径的一部分的 jar 中。

我的 pom.xml 的报告部分如下所示：

注意：
${m2Repository}被定义为文件上层的属性，
定义为${env.USERPROFILE}/.m2/repository
${bootClassPath}定义为文件上层的属性，
定义为${env.JRE_6_HOME}\lib\rt.jar;${env.JAVA_HOME}\lib\tools.jar;

我该如何解决NoClassDefFoundError？

此外，我希望我的 SiteMap 文件作为正常构建过程的一部分compile在package.

我已经尝试在 中定义它build，但是 javadoc 没有被创建，而且我没有看到我的 Doclet 的任何日志输出。

更新：
感谢@ben75 的建议。我已经删除了pom.xml<reporting>的部分，现在在构建过程中该过程失败了。我从. _<goals><configuration><reporting>

它仍在抛出，NoClassDefFoundError但它发生在我想要的构建位置。我尝试添加：

到配置部分，但这不起作用。