2009-09-30 18 views
5

Quiero hacer un Javadoc a partir de un archivo de compilación de ant, pero no veo dónde está. En build.xml tengo:¿Cómo generar javadoc con ant, para un proyecto existente?

<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> 

¿Dónde se encuentra el Javadoc? ¿Es un archivo oculto o algo colocado en ese directorio?

Respuesta

14

Tiene un objetivo doc definido que genera javadoc en ${doc.dir} que se establece en 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> 

Por lo tanto, para generar el javadoc basta con ejecutar:

$ ant doc 

y se encontrará en el directorio doc sub.

0

Si está utilizando Eclipse, y los archivos de origen son menos de $ {} source.dir/principal, esto funciona:

<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> 
+0

Por cierto, es mejor poner '' en la sección 'clean' ... –

Cuestiones relacionadas