2012-10-24 17 views
7

Próbuję wygenerować pliki HTML Javadoc dla mojego projektu. Generuję je za pomocą wtyczki Maven Javadoc (maven-javadoc-plugin). Używam Mavena 2.2.1. Wszystko generuje tak, że wszystkie właściwe informacje są tam, ale HTML wygląda po prostu okropnie. Tak źle, że nie chcę tego publikować w ten sposób. Oto zrzut ekranu:Dlaczego moje wygenerowane Javadoki wyglądają okropnie?

(. UWAGA: Tak, widzę „JavaScript jest wyłączony w Twojej przeglądarce” komunikat Nawet jeśli klikam IE 8 ostrzeżenie o zawartości aktywnego i go włączyć, nie ma znaczenia)

Screenshot of messed up Javadoc formatting

Istnieją różnego rodzaju niepotrzebnych podziałów wierszy i formatowanie podstawowy jest tylko bzdury. Czy czegoś brakuje? Spodziewałem się zobaczyć wygenerowane Javadocs, które wyglądają podobnie do tego, co widzę w Eclipse, gdy zatrzymam kursor nad klasą lub metodą i zobaczę okienko Javadoc.

Próbowałem dodać ustawienie w moim pliku POM, ale naprawdę nie wiem, co robię, jeśli chodzi o konfigurowanie generatora Javadoc. Oto co mam w tej chwili (wewnątrz elementu <reporting>):

<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> 

Wszelkie sugestie?


UPDATE:

Rozwiązanie według Paulius działa doskonale. Usunąłem powyższą sekcję z mojej sekcji <reporting>, ponieważ było to całkowicie niepotrzebne. Dodałem nowy element <plugin>, jak określono poniżej. Mój plik POM zawiera teraz nowy blok:

<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> 

Oto co stałe wyjście wygląda następująco:

Properly generated Javadoc

+3

Może to nie być spowodowane komunikatem o błędzie u góry: * "Javascript jest wyłączony w przeglądarce" *? – assylias

+0

Wygląda, że ​​faktycznie "lepiej" w przeglądarce: http://docs.oracle.com/javase/7/docs/api/ – PeterMmm

+0

Javadoc powinien renderować bez włączonego JS ... – PeterMmm

Odpowiedz

2

spróbować usunąć maven-javadoc-plugin z reporting sekcji. Jeśli korzystasz z Maven 3, sekcja raportowania jest przestarzała i powinna zostać usunięta.

Spróbuj dodać następujące:

<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> 

do sekcji Maven plugins i uruchom go. Używam w ten sposób maven-javadoc-plugin i generuje normalne javadocs.

Mam nadzieję, że to pomoże.

+0

Przepraszam, powinienem wspomnieć, że używam Mavena 2.2.1. Pierwotnie nie miałem tego bloku w ogóle. Dodałem go tylko, aby spróbować rozwiązać ten problem. –

+0

Tak, to działało idealnie! Dziękuję bardzo! –

+0

Nie ma za co :) –

Powiązane problemy