簡體   English   中英

Maven,javadoc:沒有 package 的源文件

[英]Maven, javadoc : No source files for package

我正在寫一個目錄結構為 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:javadocfrtex/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中的文件?

這是一個遲到的回應,但我剛剛遇到了同樣的問題。

解決方案是您需要將以下內容添加到configuration部分中的插件中

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

問題不在於您的 Maven 配置。

您需要為 utils 包包含一個package-info.java

它是一個位於src/main/java/utils/package-info.java ,它將包含包的 javadoc,與類的 javadoc 形成對比。

有關包級 javadoc 的更多信息, 您可以閱讀文檔

盡管locus2k 的答案一開始對我有用,但它只是掩蓋了我在 Javadoc 無法找到目錄結構時遇到的真正潛在問題。

就我而言,我在 IntelliJ 中錯誤地創建了一個單獨的目錄結構,用點分隔它們,例如: src/main/java/wrong.folder.structure/而不是: src/main/java/right/folder/structure/

IntelliJ 中的折疊視圖顯示兩個結構相同。

也許不是每個人的問題,但這是我的問題。

如果您使用較新的 Java 版本來構建項目,也會出現此問題,盡管警告是錯誤,這會導致構建失敗。 就我而言,我正在使用 Java 12 (Bellsoft) JDK 構建 Java 8 項目。

要解決這個問題,您可以使用 Java 8 JDK,或者更好的是,將<source>8</source>maven-javadoc-pluginconfiguration部分(類似於 @locus2k解決方案)。

我還沒有解決這個問題,但我可以說,對我來說,這是在我將Multi-Release: true添加到清單文件時觸發的。 這里有一些討論:

Java 11/12 帶有 maven 的 Javadoc 導致不為測試生成 Javadoc

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM