自定义index.html javadoc页面?

时间:2012-04-30 09:52:13

标签: java ant javadoc

我正在使用ant task运行javadoc:

<target name="javadoc"  description="create javadoc">
    <delete dir="javadoc" />
    <mkdir dir="javadoc" />
    <javadoc destdir="javadoc">
        <fileset dir="src/main/java" includes="sk/**" />
    </javadoc>
</target>

我想更改默认的index.html页面以提供简短的用户指南。我可以改变index.html将它复制到其他地方并在javadoc的ant任务完成后重写它,但这似乎有点愚蠢。是否有更常见的方法来实现这一目标?感谢

2 个答案:

答案 0 :(得分:12)

您正在寻找javadoc的-overview选项。有关详细信息,请参阅http://docs.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html#overviewcomment

答案 1 :(得分:3)

在Ant中,您需要使用overview属性,如下所示:

<javadoc destdir="javadoc" overview="src/overview.html">...</javadoc>