2012-10-24 112 views
7

我正在嘗試爲我的項目生成Javadoc HTML文件。我通過Maven Javadoc插件(maven-javadoc-plugin)生成它們。我正在使用Maven 2.2.1。所有東西都會產生這樣的信息,但HTML看起來很糟糕。太糟糕了,我不想以這種方式發佈它。下面是截圖:爲什麼我生成的Javadocs看起來很糟糕?

注:是的,我看到消息「的JavaScript在瀏覽器中禁用」即使我點擊IE 8的警告有關活動內容,並啓用它,它沒有什麼區別)

Screenshot of messed up Javadoc formatting

有各種不必要的換行符,其基本格式就是廢話。我錯過了什麼嗎?如果我將鼠標懸停在類或方法上並看到彈出的Javadoc面板,我期待看到生成的Javadoc與我在Eclipse中看到的類似。

我試過在我的POM文件中添加設置,但我真的不知道我在配置Javadoc生成器時做了什麼。這是我目前所面對的(在<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> 

有什麼建議?


UPDATE:

由Paulius提供的解決方案完美地工作。我從<reporting>部分刪除了上面的部分,因爲這完全沒有必要。我添加了新的<plugin>元素,如下所示。我的POM文件現在包含此新的塊:

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

這裏是固定的輸出是什麼樣子:

Properly generated Javadoc

+3

難道這不是由於頂部的錯誤消息:*「JavaScript在瀏覽器上被禁用」*? – assylias

+0

看起來實際上在你的瀏覽器中「更好」:http://docs.oracle.com/javase/7/docs/api/ – PeterMmm

+0

Javadoc應該呈現沒有JS啓用... – PeterMmm

回答

2

嘗試從reporting部分刪除maven-javadoc-plugin。如果您使用的是Maven 3,則報告部分已棄用,應予以刪除。

嘗試添加以下內容:

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

到Maven plugins部分並運行它。我正在使用這樣的maven-javadoc-plugin,它會生成正常的javadoc。

希望這會有所幫助。

+0

對不起,應該提到我正在使用Maven 2.2.1。我原本沒有這個塊。我只是添加它來嘗試解決這個問題。 –

+0

是的,這工作完美!非常感謝! –

+0

不客氣:) –

相關問題