2012-10-24 117 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

不客气:) –

相关问题