自定义索引.html javadoc 页面

Question

我正在使用ant任务运行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>

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

Answer 1

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

Answer 2

在 Ant 中，你需要像这样使用 overview 属性：

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