Maven Javadoc未能找到我的子包-“Javadoc：警告-没有包的源文件”

Question

我有一个Maven项目。我试图让Maven在mvn包发布时自动生成JavaDocs。整个项目编译和打包都很好。它已经为主包中的所有Java类生成了文档，但没有为子包中的任何类生成文档。它说它找不到他们。

确切的错误消息是：

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

我的项目结构如下：

pom.xml
src (directory)
    main (directory)
        java (directory)
            parser (directory)
                Parser.java
                StringParser.java
                ByteParser.java
            Main.java
            Reader.java

这些课程是主要的。java和Reader。java有“包com”。个人的读取器；'。解析器目录中的类具有“package com”。个人的读者解析器；'。错误消息似乎表示无法找到“com”。个人的读者解析器'。

我的pom。xml如下所示：（为了简洁起见删除了一些内容）

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.personal.reader</groupId>
    <artifactId>Reader</artifactId>
    <packaging>jar</packaging>
    <version>0.1.0</version>
    <name>Reader</name>
    <url>http://maven.apache.org</url>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>3.0.0</version>
                <configuration>
                    <outputDirectory>docs</outputDirectory>
                </configuration>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

我试图寻找解决方案。我发现的最接近的是这个StackOverflow问题。似乎没有明确的答案。我尝试编译提交者答案中链接的项目，看看他是否解决了它。提交者的项目仍然表现出与我相同的问题。

我尝试在src/main/java和src/main/java/parser中创建package-info.java文件。这似乎不起作用。

我试着搞乱maven javadoc插件。我研究了sourceFileIncludes、includeDependencySources、subpackages和dependencySourceIncludes。它们似乎都不起作用。我可能错过了什么。

如何解决Maven不包括生成Javadocs的子包的问题？

Answer 1

看起来我已经找到了我的答案。我把它贴在这里，这样其他有同样问题的人可以在这里找到它。

我是如何做到的：我再次尝试了maven javadoc插件中的sourceFileIncludes标记。我在项目pom的插件中添加了这个。xml。

<sourceFileIncludes>
    <sourceFileInclude>**/*.java</sourceFileInclude>
</sourceFileIncludes>

项目pom中的整个插件。xml如下所示：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.0.0</version>
    <configuration>
        <outputDirectory>docs</outputDirectory>
        <sourceFileIncludes>
            <sourceFileInclude>**/*.java</sourceFileInclude>
        </sourceFileIncludes>
    </configuration>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

它成功地在解析器目录中的类上生成了Javadocs文档。我想它也可以用于其他目录或更深层的目录。如果没有，您可以添加另一个<代码>

我不是百分之百确定这是否是正确的答案，但它确实对我很有效。如果有人有更好的解决方案，请继续在这里发布。