为什么我生成的Javadocs看起来很糟糕?

时间:2012-10-24 12:48:02

标签: java maven javadoc

我正在尝试为我的项目生成Javadoc HTML文件。我通过Maven Javadoc插件(maven-javadoc-plugin)生成它们。我正在使用Maven 2.2.1。一切都产生了所有适当的信息,但HTML看起来很糟糕。太糟糕了,我不想那样发布它。这是一个截图:

注意:是的,我看到'您的浏览器已禁用JavaScript'消息。即使我单击IE 8关于活动内容的警告并启用它,也没有区别)

Screenshot of messed up Javadoc formatting

有各种不必要的换行符,基本格式只是垃圾。我错过了什么吗?我希望看到生成的Javadocs与我在Eclipse中看到的类似,如果我将鼠标悬停在类或方法上并看到弹出的Javadoc面板。

我已经尝试在我的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>

有什么建议吗?


更新

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

1 个答案:

答案 0 :(得分:2)

尝试从maven-javadoc-plugin部分删除reporting。如果您使用的是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。

希望这有帮助。