Custom index.html javadoc page?

Question

I run javadoc with the ant task:

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

I want to change the default index.html page to provide a quick start guide. I can change index.html to copy it to another place and rewrite it after completing the ant task for javadoc, but this seems a little silly. Is there a more general way to achieve this? Thanks

Answer 1

You are looking for the -overview option for javadoc. See http://docs.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html#overviewcomment for more details .

Answer 2

In Ant, you need to use the attribute overviewas follows:

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