Question

我正在编写一个带有目录结构的maven package

frtex
   pom.xml
frtex/src/main/java/some-files.java
frtex/src/main/java/utils/some-other-files.java

使mvn test正常工作。

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

[WARNING] javadoc: warning - No source files for package utils

以下是我的pom.xml的相关（？）部分：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.10.4</version>
    <configuration>
        <groups>
            <group>
                <title>TI</title>
                <packages>frtex.*</packages>
            </group>
        </groups>

        <doclet>ch.raffael.doclets.pegdown.PegdownDoclet</doclet>
        <docletArtifact>
            <groupId>ch.raffael.pegdown-doclet</groupId>
            <artifactId>pegdown-doclet</artifactId>
            <version>1.1</version>
        </docletArtifact>
        <useStandardDocletOptions>true</useStandardDocletOptions>
    </configuration>
</plugin>

project/build/plugins

中的

如何让maven / javadoc找到src/main/java/utils中的文件？

Answer 1

问题不在您的maven配置中。

您需要为utils包添加package-info.java。

这是一个位于src/main/java/utils/package-info.java的文件，它包含了包的javadoc，而不是类的javadoc。

有关包级别javadoc的更多信息，请you can read the documentation。

Answer 2

这是一个较晚的答复，但我遇到了同样的问题。

解决方案是您需要在configuration部分的插件中添加以下内容

<configuration>
   <sourcepath>src/main/java</sourcepath>
   ...
</configuration>

Answer 3

如果您使用较新的Java版本来构建项目，也会出现此问题，尽管警告是错误，导致构建失败。就我而言，我正在使用 Java 12 (Bellsoft) JDK 构建 Java 8 项目。

要解决这个问题，您可以使用 Java 8 JDK，或者更好的是，将 <source>8</source> 添加到 configuration 的 maven-javadoc-plugin 部分（类似于 @locus2k {{3} }).

Answer 4

虽然 locus2k's answer 一开始对我有用，但它只是掩盖了我在 Javadoc 无法找到目录结构时遇到的真正潜在问题。

就我而言，我错误地在 IntelliJ 中创建了一个单独的目录结构，用点分隔它们，例如：src/main/java/wrong.folder.structure/ 而不是： src/main/java/right/folder/structure/

IntelliJ 中的折叠视图显示两个结构相同。

也许不是每个人的问题，但这是我的问题。

Maven，javadoc：没有包的源文件

4 个答案: