Come generare javadoc con formica, per un progetto esistente?

Question

Voglio creare un Javadoc da un file di build ant, ma non vedo dove sia. In build.xml ho:

<description> 
    A sample build file for this project 
    </description> 

    <property name="source.dir" location="src"/> 
    <property name="build.dir" location="bin"/> 
    <property name="doc.dir" location="doc"/> 
    <property name="main.class" value="proj1.Proj1"/> 

    <target name="init" description="setup project directories"> 
    <mkdir dir="${build.dir}"/> 
    <mkdir dir="${doc.dir}"/> 
    </target> 

    <target name="compile" depends="init" description="compile java sources"> 
    <javac srcdir="${source.dir}" destdir="${build.dir}"/> 
    </target> 

    <target name="run" description="run the project"> 
    <java dir="${build.dir}" classname="${main.class}" fork="yes"> 
     <arg line="${args}"/> 
    </java> 
    </target> 

    <target name="clean" description="tidy up the workspace"> 
    <delete dir="${build.dir}"/> 
    <delete dir="${doc.dir}"/> 
    <delete> 
     <fileset defaultexcludes="no" dir="${source.dir}" includes="**/*~"/> 
    </delete> 
    </target> 

    <!-- Generate javadocs for current project into ${doc.dir} --> 
    <target name="doc" depends="init" description="generate documentation"> 
    <javadoc sourcepath="${source.dir}" destdir="${doc.dir}"/> 
    </target> 

</project> 

Dove si trova Javadoc? È un file nascosto o qualcosa inserito in quella directory?

Answer 1

È stato definito un target doc che genera javadoc in ${doc.dir} impostato su doc.

<!-- Generate javadocs for current project into ${doc.dir} --> 
    <target name="doc" depends="init" description="generate documentation"> 
    <javadoc sourcepath="${source.dir}" destdir="${doc.dir}"/> 
    </target> 

Quindi, per generare il javadoc basta eseguire:

$ ant doc 

e troverete nella directory doc sub.

Answer 2

Se si utilizza Eclipse, e i file di origine sono sotto $ {} source.dir/principale, questo funziona:

<target name="doc" depends="init" description="generate documentation"> 
<delete dir="${doc.dir}" /> 
<mkdir dir="${doc.dir}" /> 
    <javadoc destdir="${doc.dir}"> 
     <fileset dir="${source.dir}/main" /> 
    </javadoc> 
</target>