Maven'i kullandığımdan beri, Javadoc etiketleri eksik olan yerel depo projelerimi (örneğin, eksik bir parametre) oluşturup kurabildim.

Ancak, Java 8'e (1.8.0-ea-b90) geçiş yaptığım için Maven, eksik belge etiketleri konusunda kesinlikle katı ve Javadoc'un olmadığı bir proje oluşturmaya veya yüklemeye çalıştığımda Javadoc sorunları ile ilgili birçok Javadoc hatası göster "mükemmel". Yerel veri havuzumda derlemeye ve kurmaya çalıştığım bazı projeler, kontrol sahibi olmadığım üçüncü taraf projeler. Bu yüzden, tüm bu projelerde tüm Javadoc'ları düzeltmenin çözümü benim senaryomda mümkün görünmüyor.

Bu, projemde yürüttüğümde gördüğüm çıktının küçük bir kısmı mvn clean package install:

[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 9.026s
[INFO] Finished at: Mon Apr 08 21:06:17 CEST 2013
[INFO] Final Memory: 27M/437M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9:jar (attach-javadocs) on project jpc: MavenReportException: Error while creating archive:
[ERROR] Exit code: 1 - /Users/sergioc/Documents/workspaces/heal/jpc/src/main/java/org/jpc/engine/prolog/PrologDatabase.java:10: error: @param name not found
[ERROR] * @param terms the terms to assert
[ERROR] ^
[ERROR] /Users/sergioc/Documents/workspaces/heal/jpc/src/main/java/org/jpc/engine/prolog/PrologDatabase.java:11: warning: no description for @return
[ERROR] * @return
[ERROR] ^

Javadoc Maven eklentisi POM'umda şu şekilde yapılandırıldı:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Daha önce de söylediğim gibi, Java 7'ye geri dönersem her şey yolunda gidiyordur. Belki bu Maven'in Java 8'de çalışmasıyla ilgili bir hata mıdır? Java 8 ile nasıl çalıştırabilirim (yani, projenin Javadoc'unu oluşturabilir ve kodunu yerel depomda kurabilirim)? OSX'te Maven 3.0.3 ve 3.0.5 ile test yaptım.

GÜNCELLEME:

Javadoc eklenti yapılandırmamı <failOnError>false</failOnError>(teşekkürler Martin) ile değiştirirsem:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Sonra proje yerel depoma yüklenir. Ancak, Javadoc JAR hala oluşturulmaz.

Bu yeni yapılandırmayla birlikte konsolda gördüğüm çıktının bir parçası:

[ERROR] MavenReportException: Arşiv oluşturulurken hata: Çıkış kodu: 1 - /Users/....java:18: warning: no @param ... Komut satırı şuydu: / Library / Java / Home / bin / javadoc @options @packages

'/ Users / sergioc / Documents / workspace / heal / minitoolbox / target / apidocs' dizinindeki oluşturulan Javadoc dosyalarına bakın.

at org.apache.maven.plugin.javadoc.AbstractJavadocMojo.executeJavadocCommandLine (Soyut org.apache.maven.joec.exec.exec.exec.exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Exec.Execex. : 209) org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:153) org.apache şirketinde org.apache.maven.lifecycle.internal.MojoExecutor.execute (MojoExecutor.java:153). maven.lifecycle.internal.LifecycleModuleBuilder.buildProject (LifecycleModuleBuilder.java:84) org.apache.maven.lifecycle.internal.LifecycleModuleBuilder'da.org.apache.maven.lifecycle.internal.LifecycleStarter.singleThreadedBuild (LifecycleStarter.java:183) konumundaki org.apache.maven.lifecycle.internal.LifecycleStarter.singleThreadedBuild (LifecycleStarter.java:183) 'da (LifecycleStarter.java:183) (LifecycleStarter.jec:1) org.apache.maven.e.MavenCli.execute (MavenCli.java şirketinde org.apache.maven.DefaultMaven.doExecute (DefaultMaven.java:320) : 537) sun.reflect.NativeMethodAccessorImpl.invoke0 şirketinde org.apache.maven.cli.MavenCli.doMain (MavenCli.java:196) 'da (MavenCli.java:141) Native Method) sun.reflect.NativeMethodAccessorImpl.invoke (NativeMethodAccessorImpl.java:57) 'de sun.reflect.DelegatingMethodAccessorImpl.invoke (DelegatingMethodAccessorImpl.java.43.fl.hoavalang43.java.43 adresinde).org.codehaus.plexus.classworlds.launcher.Launcher.launchEnhanced (Launcher.java:290) org.codehaus.plexus.classworlds.launcher.Launcher.launch'da (Launcher.java:230) çağırın (Method.java:491) org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode'da (Launcher.java:409) org.codehaus.plexus.classworlds.launcher.Launcher.main'de (Launcher.java:352)

Kaynakların nasıl oluşturulacağı, projenin nasıl kurulacağı ve Java 7 ile çalışırken bir adımda Javadoc JAR'ın nasıl oluşturulacağı hakkında herhangi bir geçici çözüm var mı?

En iyi çözüm javadoc hatalarını düzeltmek olacaktır. Herhangi bir nedenle bu mümkün değilse (yani: otomatik oluşturulan kaynak kodu), bu kontrolü devre dışı bırakabilirsiniz.

DocLint, Java 8'de şu şekilde özetlenen yeni bir özelliktir :

Geliştirme döngüsünün başlarında ve kaynak koduna kolayca bağlanabilecek şekilde Javadoc yorumlarındaki hataları tespit etmek için bir araç sağlayın.

Bu varsayılan olarak etkindir ve Javadoc oluşturmadan önce bir sürü kontrol gerçekleştirir. Bu iş parçacığında belirtildiği gibi Java 8 için bunu kapatmanız gerekir . Bunu maven yapılandırmanıza eklemeniz gerekecek:

<profiles>
  <profile>
    <id>java8-doclint-disabled</id>
    <activation>
      <jdk>[1.8,)</jdk>
    </activation>
    <properties>
      <javadoc.opts>-Xdoclint:none</javadoc.opts>
    </properties>
  </profile>
</profiles>
<build>
  <plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.9</version>
        <executions>
            <execution>
                <id>attach-javadocs</id>
                <goals>
                    <goal>jar</goal>
                </goals>
                <configuration>
                    <additionalparam>${javadoc.opts}</additionalparam>
                </configuration>
            </execution>
        </executions>
    </plugin>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>3.3</version>
        <configuration>
          <reportPlugins>
            <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-javadoc-plugin</artifactId>
              <configuration>
                <additionalparam>${javadoc.opts}</additionalparam>
              </configuration>
            </plugin>
          </reportPlugins>
        </configuration>
      </plugin>
   </plugins>
</build>

Maaven-javadoc-plugin 3.0.0+ için: Değiştirin

<additionalparam>-Xdoclint:none</additionalparam>

ile

<doclint>none</doclint>

Hem java 8 hem de java 7 ile işlerin çalışmasını sağlamak için en kolay yaklaşım yapıda bir profil kullanmaktır:

<profiles>
  <profile>
    <id>doclint-java8-disable</id>
    <activation>
      <jdk>[1.8,)</jdk>
    </activation>

    <build>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-javadoc-plugin</artifactId>
          <configuration>
            <additionalparam>-Xdoclint:none</additionalparam>
          </configuration>
        </plugin>
      </plugins>
    </build>
  </profile>
</profiles>

Kullanılan java sürümü ne olursa olsun doclint uyarılarını görmezden gelmenin en kısa yolu. Eklenti yapılandırmasını, küçük değişikliklerle birden fazla profilde çoğaltmaya gerek yoktur.

<profiles>
  <profile>
    <id>doclint-java8-disable</id>
    <activation>
      <jdk>[1.8,)</jdk>
    </activation>
    <properties>
      <javadoc.opts>-Xdoclint:none</javadoc.opts>
    </properties>
  </profile>
</profiles>

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <version>2.9.1</version>
      <executions>
        <execution>
          <id>attach-javadocs</id> <!-- The actual id should be apparent from maven output -->
          <configuration>
            <additionalparam>${javadoc.opts}</additionalparam>
          </configuration>
        </execution>
      </executions>
    </plugin>
    ...
  </plugins>
</build>

Oracle / Open JDK 6, 7, 8 ve 11'de test edildi.

Pom dosyasındaki global özellikler bölümüne ekleyin:

<project>
    ...
    <properties>
        <additionalparam>-Xdoclint:none</additionalparam>
    </properties>

Diğer yanıtlarda (bu özelliği eklentiler bölümüne eklemek) sağlanan ortak çözüm bir nedenden dolayı işe yaramadı. Sadece küresel olarak kurarak javadoc kavanozunu başarılı bir şekilde inşa edebilirim.

Herhangi bir Java sürümü ile çalışacak en kısa çözüm:

<profiles>
    <profile>
        <id>disable-java8-doclint</id>
        <activation>
            <jdk>[1.8,)</jdk>
        </activation>
        <properties>
            <additionalparam>-Xdoclint:none</additionalparam>
        </properties>
    </profile>
</profiles>

Bunu POM'nize eklemeniz yeterlidir.

Bu temelde @ ankon'un cevabı artı @ zapp'ın cevabı .

Maaven-javadoc-plugin 3.0.0 kullanıcıları için:

değiştirmek

<additionalparam>-Xdoclint:none</additionalparam>

tarafından

<doclint>none</doclint>

DocLint'i kapatmanın en azından uzun vadede iyi bir çözüm olduğunu düşünmüyorum. Javadoc'un biraz daha sıkı hale gelmesi iyidir, bu yüzden derleme problemini düzeltmenin doğru yolu altta yatan problemi düzeltmektir . Evet, sonuçta bu kaynak kodu dosyalarını düzeltmeniz gerekecek.

Daha önce kurtulabileceğiniz şeyler şunlardır:

• Hatalı biçimlendirilmiş HTML (örneğin, eksik bir bitiş etiketi, kaçan köşeli parantezler vb.)
• Geçersiz {@link }s. (aynı etiket,@see )
• Geçersiz @authordeğerler. Bu eskiden kabul edilirdi:@author John <john.doe@mine.com> ama kaçış köşeli parantezler yüzünden artık öyle değil.
• Javadoc'taki HTML tabloları artık bir özet veya resim yazısı gerektiriyor. Açıklama için bu soruya bakın .

Sadece kaynak kodu dosyalarınızı düzeltmek ve başarısız olmadan inşa edene kadar Javadoc'unuzu oluşturmaya devam etmeniz gerekir. Hantal ama evet, kişisel olarak projelerimi DocLint seviyesine getirdiğimde hoşuma gidiyor çünkü ürettiğim Javadoc'un aslında istediğim şey olduğundan daha emin olabileceğim anlamına geliyor.

Elbette, kendi üretmediğiniz bazı kaynak kodlarında Javadoc oluşturuyorsanız, örneğin wsimport gibi bazı kod üreticilerinden geldiği için sorun var . Oracle'ın JDK8'i gerçekten yayınlamadan önce kendi araçlarını JDK8 uyumluluğu için hazırlamadığı garip. Java 9'a kadar düzeltilmeyecek gibi görünüyor . Sadece bu özel durumda DocLint'i bu sayfanın başka bir yerinde belgelendiği şekilde kapatmanızı öneririm.

maven-javadoc-pluginYalnızca yapılandırmayı geçersiz kılmak , sorunu çözmez mvn site(örn. Çıkış aşamasında kullanılır). İşte yapmam gerekenler:

<profile>
  <id>doclint-java8-disable</id>
  <activation>
    <jdk>[1.8,)</jdk>
  </activation>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <configuration>
          <additionalparam>-Xdoclint:none</additionalparam>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>3.3</version>
        <configuration>
          <reportPlugins>
            <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-javadoc-plugin</artifactId>
              <configuration>
                <additionalparam>-Xdoclint:none</additionalparam>
              </configuration>
            </plugin>
          </reportPlugins>
        </configuration>
      </plugin>
    </plugins>
  </build>
</profile>

failOnErrorÖzelliği şu şekilde ayarlamayı deneyebilirsiniz ( eklenti belgelerine bakın ) false:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <executions>
        <execution>
            <id>attach-javadocs</id>
            <goals>
                <goal>jar</goal>
            </goals>
            <configuration>
              <failOnError>false</failOnError>
            </configuration>
        </execution>
    </executions>
</plugin>

Dokümanlardan da görebileceğiniz gibi, varsayılan değer true.

Maven komutunu çalıştırmak için kullanılan JRE sürümünüze bağlı olduğundan DocLint, pom.xml'nizde varsayılan olarak devre dışı bırakmak istemiyorsanız

Bu nedenle, komut satırından anahtarı kullanabilirsiniz -Dadditionalparam=-Xdoclint:none.

Misal: mvn clean install -Dadditionalparam=-Xdoclint:none

Configuration özelliği adı, maven-javadoc-plugin'in 3.0.0 olan en son sürümünde değiştirildi.

Bu yüzden <additionalparam> çalışmaz. Bu yüzden aşağıdaki gibi değiştirmeliyiz.

   <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <version>3.0.0</version>
      <configuration>
         <doclint>none</doclint>
      </configuration>
  </plugin>

Diğer cevaplara bir bakış eklemek istiyorum

Benim durumumda

-Xdoclint: yok

İşe yaramadı.

Bununla başlayalım, projemde javadoc'a gerçekten ihtiyacım yoktu. Sadece bazı gerekli eklentilerin derleme süresi bağımlılığı vardı.

Yani, sorunumu çözmenin en basit yolu şuydu:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
        <skip>true</skip>
    </configuration>
</plugin>

İtibariyle kullanmakta olması gereken 3.0.0 maven-javadoc-eklentisi additionalJOption Eğer devre dışı doclint için Javadoc istiyorum eğer öyleyse, ek bir Javadoc seçeneği ayarlamak için, aşağıdaki özelliği eklemek gerekir.

<properties>
    ...
    <additionalJOption>-Xdoclint:none</additionalJOption>
    ...
<properties>

Ayrıca maven-javadoc-plugin'in 3.0.0 veya daha yüksek bir versiyonundan da bahsetmelisiniz.

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.0.0</version>    
</plugin>

Yani, kendimi yapmadığım birkaç saat kaydedin ve işe yaramazsa bunu deneyin:

 <additionalJOption>-Xdoclint:none</additionalJOption>

Etiket daha yeni sürümler için değiştirilir.

Aşağıdan eklendi

JAVA_TOOL_OPTIONS=-DadditionalJOption=-Xdoclint:none

Jenkins işine:

Yapılandırma> Oluşturma Ortamı> Oluşturma işlemine ortam değişkenlerini ekleme> Özellikler İçerik

Jenkins Maven ile kod oluşturma sorunumu çözdüm :-)

Bu yardımcı olacak emin değilim, ama ben bile oozie-4.2.0 sürümü ile çok yakın zamanda aynı sorunla karşı karşıya . Yukarıdaki cevapları okuduktan sonra sadece komut satırı üzerinden maven seçeneğini ekledim ve benim için çalıştı. Yani, sadece burada paylaşıyorum.

Java 1.8.0_77 kullanıyorum , java 1.7 ile denemedim

bin / mkdistro.sh -DskipTests -Dmaven.javadoc.opts = '- Xdoclint: -html'

Eksik @paramve @returnetiketleri yok saymak için missing doclint grubunu devre dışı bırakmak yeterlidir . Bu şekilde, javadoc daha üst düzey ve sözdizimi sorunları için denetlenecektir:

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.0.0</version>
        <configuration>
            <doclint>all,-missing</doclint>
        </configuration>
    </plugin>

Bu sürüm 3.0 veya daha yeni bir eklenti için unutmayın.

Partiye biraz geç kaldım, ama ben de geçici çözüm aramak zorunda kaldım, burada sona erdi ve sonra buldum.

Benim için işe yarar: -

export JAVA_TOOL_OPTIONS=-DadditionalJOption=-Xdoclint:none

Ve sonra Maven'in gerektirmediğini bu konuda vs. Güzel şey sizin Maven yapı, herhangi bir Linux dağıtımı yapı oluşturmaya başla yapılandırma dosyaları modifikasyon - Ben nesnel bir demet yeniden olduğu gibi yapamazdım Centos rpm paketleri, böylece zorunda gerçekten derine in.