Início / coding / Perguntas / 77748120
Accepted
suprB
Asked: 2024-01-03 03:16:51 +0800 CST

maven-javadoc-plugin não gera javadocs

  • 772

Tenho um projeto com a seguinte estrutura:

parent
 |-api
 |-plugin (depends on api)

O projeto é construído usando as clean install packagetarefas do maven no módulo pai. Os JARs são gerados corretamente, mas os javadocs não. Como posso consertar isso?

Esta é a aparência do pom do meu módulo pai:

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>PluginLogger</groupId>
    <artifactId>parent</artifactId>
    <version>1.1</version>
    <packaging>pom</packaging>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
    </properties>

    <modules>
        <module>plugin</module>
        <module>api</module>
    </modules>

    // repositories and dependencies go here...

    <build>
        <defaultGoal>clean install package</defaultGoal>

        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-javadoc-plugin</artifactId>
                    <version>3.6.3</version>
                    <configuration>
                        <outputDirectory>${project.build.directory}/javadoc</outputDirectory>
                        <sourceFileIncludes>
                            <include>**/me/suprB/pluginlogger/api/**/*.java</include>
                        </sourceFileIncludes>
                    </configuration>
                    <executions>
                        <execution>
                            <id>attach-javadocs</id>
                            <phase>package</phase>
                            <goals>
                                <goal>aggregate</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>
</project>

Eu só quero gerar os Javadocs para o módulo "api", não para o "plugin".

maven

1 respostas

  1. Best Answer

    Criei um pequeno POC com uma estrutura semelhante à que você forneceu. Com base em minhas descobertas, gostaria de sugerir o seguinte:

    • Por favor, não use o final **da <include>tag
    • uso reportOutputDirectorye destDirconfigurações em vez deoutputDirectory
    • Na minha opinião você não deveria usar pluginManagementaqui, já que o plugin é usado apenas pelo pai pom.

    Exemplo de POM pai

    Este é o valor real pom.xmldo módulo pai do meu PoC:

    <?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.github.tcsizmadia</groupId>
    <artifactId>maven-javadoc-sandbox</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>
    <modules>
        <module>api</module>
        <module>plugin</module>
    </modules>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>3.6.3</version>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <phase>package</phase>
                        <goals>
                            <goal>aggregate</goal>
                        </goals>
                        <configuration>
                            <sourceFileIncludes>
                                <sourceFileInclude>com/github/tcsizmadia/api/**</sourceFileInclude>
                            </sourceFileIncludes>
                            <reportOutputDirectory>${project.build.directory}</reportOutputDirectory>
                            <destDir>javadoc</destDir>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

    Árvore de diretórios após emissão mvn clean installno módulo pai:

    ├── javadoc
│   ├── com
│   │   └── github
│   │       └── tcsizmadia
│   │           └── api
│   │               └── class-use
│   ├── legal
│   ├── resources
│   └── script-dir
│       └── images
└── javadoc-bundle-options

    Como você pode ver, ele não contém nenhuma documentação do pluginmódulo - apenas do api, conforme você solicitou.

    • 0

relate perguntas