2012-10-24 28 views
7

Projem için Javadoc HTML dosyalarını oluşturmaya çalışıyorum. Onları Maven Javadoc eklentisi (maven-javadoc-plugin) aracılığıyla üretiyorum. Maven 2.2.1 kullanıyorum. Her şey, tüm uygun bilgilerin orada olduğu şekilde üretiyor, ancak HTML sadece korkunç görünüyor. O kadar kötü ki, bu şekilde yayınlamak istemiyorum.Oluşturulmuş Javadocs'larım neden korkunç görünüyor?

(NOT:. Evet, bunu aktif içerik hakkında IE 8 uyarıyı tıklayın ve etkinleştirmek bile, hiç fark etmez mesajı 'JavaScript tarayıcınızda devre dışı' bakınız)

İşte bir ekran görüntüsü

Screenshot of messed up Javadoc formatting

gereksiz satır sonları her türlü vardır ve temel biçimlendirme sadece bok. Bir şey mi eksik? Bir sınıf veya yöntem üzerinde gezindiyse ve popup Javadoc panelini görsem Eclipse'de gördüğüm şeye benzeyen oluşturulmuş Javadocs'ları görmeyi bekliyordum.

benim POM dosyasında ayarı ekleyerek denedim ama Javadoc jeneratör yapılandırılması için geldiğinde ben gerçekten ne yaptığımı bilmiyorum. İşte şu anda (<reporting> öğesinin içinde) Ben ne:

<plugin> 
    <groupId>org.apache.maven.plugins</groupId> 
    <artifactId>maven-javadoc-plugin</artifactId> 
    <version>2.9</version> 
    <configuration> 
     <javadocExecutable>C:\Java\jdk1.7.0_05\bin\javadoc.exe</javadocExecutable> 
     <javadocVersion>1.7</javadocVersion> 
     <locale>en_US</locale> 
     <show>package</show> 
     <verbose /> 
    </configuration> 
</plugin> 

herhangi bir öneriniz?


GÜNCELLEME: Paulius tarafından sağlanan çözüm mükemmel çalıştı

. Yukarıdaki bölümü tamamen gereksiz olduğu için <reporting> bölümümden kaldırdım. Aşağıda belirtildiği gibi yeni <plugin> öğesini ekledim. Benim POM dosyası artık bu yeni bloğu içerir:

<build> 
    <plugins> 
     <plugin> 
      <groupId>org.apache.maven.plugins</groupId> 
      <artifactId>maven-javadoc-plugin</artifactId> 
      <version>2.8.1</version> 
      <executions> 
       <execution> 
        <id>attach-javadocs</id> 
        <goals> 
         <goal>jar</goal> 
        </goals> 
       </execution> 
      </executions> 
     </plugin>   
     ... 
    </plugins> 
</build> 
İşte

gibi sabit çıkış görünür:

Properly generated Javadoc

+3

üst az hata mesajı nedeniyle olamazdı: * * "JavaScript tarayıcınızda devre dışı"? http://docs.oracle.com/javase/7/docs/api/ JS olmadan oluşturulması gerekir – assylias

+0

tarayıcınızda aslında "daha iyi" Görünüşe Javascript ve Javascript olmayan versiyon arasında geçiş yapmak için. Assylias şüphesinin doğru olduğunu düşünüyorum. – PeterMmm

+0

Javadoc etkin ... – PeterMmm

cevap

2

deneyin reporting bölümünden maven-javadoc-plugin kaldırın. Maven 3'ü kullanıyorsanız, raporlama bölümü kullanımdan kaldırılır ve kaldırılmalıdır.

aşağıdaki eklemeyi deneyin:

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

sizin maven plugins bölümüne ve çalıştırın. Bu gibi maven-javadoc-plugin kullanıyorum ve normal javadocs üretir.

Bu yardımcı olur umarım.

+0

Maalesef Maven 2.2.1 kullanıyorum. Aslında bu bloğa hiç sahip değildim. Sadece bu sorunu çözmeye çalışmak için ekledim. –

+0

Evet, bu mükemmel çalıştı! Çok teşekkürler! –

+0

Rica ederim :) –

İlgili konular