[opencms-dev] JavaDoc Ant Target

[Guy Zürcher]

Hello OpenCMSers...

        while having looked for some JavaDoc for OpenCMS v5, i saw that
others had the same problem. So i did this small javadoc target for use with
Ant. Perhaps some of the project-people will integrate it into build.xml?

bye

    Guy ...


---SNIP--- 
<?xml version="1.0"?>

<project name="OpenCMS-JavaDoc" basedir="." default="all">

  <!-- global settings & variables -->
    <property name="version.number"             value="5.0.0"/>

    <property name="version.name"               value="Kaitain"/>
    <property name="app.name"                   value="opencms"/>

    <property name="destdir"                    location="../"/>

    <property name="zip.home"                   location="${destdir}/zip"/>
    <property name="pdf.home"                   location="${destdir}/pdf"/>
    <property name="build.home"
location="${destdir}/build"/>

    <property name="build.classes"
location="${build.home}/classes"/>
    <property name="build.inputlib"
location="${destdir}/ExternalComponents"/>
    <property name="build.web"
location="${build.home}/${app.name}"/>
    <property name="build.webinf"
location="${build.web}/WEB-INF"/>
    <property name="build.metainf"
location="${build.web}/META-INF"/>
    <property name="build.lib"
location="${build.webinf}/lib"/>
    <property name="build.local"
location="${destdir}/local"/>

    <property name="build.inputlib.servlet"
value="${build.inputlib}/servlet.jar"/>
    <property name="build.inputlib.activation"
value="${build.inputlib}/activation.jar"/>
    <property name="build.inputlib.mail"
value="${build.inputlib}/mail.jar"/>
    <property name="build.inputlib.xerces"
value="${build.inputlib}/xerces-1_4_4.jar"/>
    <property name="build.inputlib.mysql"
value="${build.inputlib}/mysql-connector-java-2_0_14-bin.jar"/>
    <property name="build.inputlib.fesi"
value="${build.inputlib}/fesi.jar"/>
    <property name="build.inputlib.oracle"
value="${build.inputlib}/classes12.zip"/>
    <property name="build.inputlib.oro"
value="${build.inputlib}/jakarta-oro-2_0_6.jar"/>
    <property name="build.inputlib.tidy"
value="${build.inputlib}/Tidy.jar"/>
    <property name="build.inputlib.uuid"
value="${build.inputlib}/jug.jar"/>

    <!-- added for javadoc target -->
    <property name="build.javasrc"              location="src/"/>
    <property name="build.javadoc"
location="${build.home}/javadoc"/>

  <!-- set things up -->
  <target name="prepare">
    <mkdir dir="${build.javadoc}"/>
  </target>

  <!-- javadoc -->
  <target name="javadoc" depends="prepare">

    <javadoc packagenames="com.opencms.*"
             sourcepath="${build.javasrc}/"
             destdir="${build.javadoc}/"
             defaultexcludes="yes"
             author="false"
             version="false"
             private="false"
             use="true">

      <classpath>
        <pathelement location="${build.inputlib.servlet}"/>
        <pathelement location="${build.inputlib.activation}"/>
        <pathelement location="${build.inputlib.mail}"/>
        <pathelement location="${build.inputlib.xerces}"/>
        <pathelement location="${build.inputlib.oracle}"/>
        <pathelement location="${build.inputlib.mysql}"/>
        <pathelement location="${build.inputlib.fop}"/>
        <pathelement location="${build.inputlib.oro}"/>
        <pathelement location="${build.inputlib.tidy}"/>
        <pathelement location="${build.inputlib.uuid}"/>
        <pathelement location="${build.inputlib.fesi}"/>
      </classpath>

    </javadoc>
  </target>

  <!-- default target -->
  <target name="all" depends="prepare,javadoc">
    <echo message="building requested target(s) ..."/>
  </target>

</project>
---SNAP---