JAVA DOC

[Meet Gaurav]

Unable to generate Java doc. getting jar missing.

But I can able to compile the same class with same classpath..And the class file is generatiing..

javadoc comm*.java -d docs

[Campbell Ritchie]

What's comm*? Please check that the javadoc tool is in your PATH (not CLASSPATH).

[Casttro Francis]

Try to develop a script file and run
[ December 10, 2008: Message edited by: Casttro Francis ]

[Meet Gaurav]

Hi
Am trying to create API docs.. Am using the below code and here the packages are dependent of another package and while executing the code in bat file am getting error saying import not found like..How to resolve this one.. Please assist

javadoc  $SOURCES_DIR/com/faa/kcc/cam/*.java -d $INSTALL_DIR/docs -windowtitle "AMAZON- API Documentation" -use -splitindex
javadoc  $SOURCES_DIR/com/faa/kcc/cam/run/*.java -d $INSTALL_DIR/docs -windowtitle "AMAZON- API Documentation" -use -splitindex
javadoc  $SOURCES_DIR/com/faa/kcc/cam/utility/*.java -d $INSTALL_DIR/docs -windowtitle "AMAZON- API Documentation" -use -splitindex
javadoc  $SOURCES_DIR/com/faa/kcc/cam/actiondata/*.java -d $INSTALL_DIR/docs -windowtitle "AMAZON- API Documentation" -use -splitindex
javadoc  $SOURCES_DIR/com/faa/kcc/cam/handler/*.java -d $INSTALL_DIR/docs -windowtitle "AMAZON- API Documentation" -use -splitindex

[Campbell Ritchie]

Please post the full error message.

[Ove Lindström]

Use ANT. (http://ant.apache.org/)

Asuming that your source code is in the directory c:\projects\demo\src and the build.xml file in in the c:\projects\demo, then this ANT-file builds, packs and documents the project.

This is my basic ant script, also found in the ant-documentation.

  <project name="RanchHand" default="dist" basedir=".">
    <description>
        simple example build file
    </description>
  <!-- set global properties for this build -->
  <property name="src" location="src"/>
  <property name="build" location="build"/>
  <property name="dist"  location="dist"/>
  <property name="docs"  location="docs"/>
 
  <target name="init">
    <!-- Create the time stamp -->
    <tstamp/>
    <!-- Create the build directory structure used by compile -->
    <mkdir dir="${build}"/>
  </target>
 
  <target name="compile" depends="init"
        description="compile the source " >
    <!-- Compile the java code from ${src} into ${build} -->
    <javac srcdir="${src}" destdir="${build}"/>
  </target>
 
  <target name="dist" depends="compile"
        description="generate the distribution" >
    <!-- Create the distribution directory -->
    <mkdir dir="${dist}/lib"/>
 
    <!-- Put everything in ${build} into the MyProject-20080627.jar file -->
    <jar jarfile="${dist}/lib/MyProject-20080627.jar" basedir="${build}"/>
  </target>
 
  <target name="clean"
        description="clean up" >
    <!-- Delete the ${build} and ${dist} directory trees -->
    <delete dir="${build}"/>
    <delete dir="${dist}"/>
<delete dir="${docs}"/>

  </target>
  
  
  <target name="javadoc" depends="compile">
<mkdir dir="${doc}"/>
<javadoc
           destdir="${docs}/api"
           author="true"
           version="true"
           use="true"
           windowtitle="Ranch Hand API">
 
    <packageset dir="src" defaultexcludes="yes">
      <include name="lime/**"/>
      <exclude name="lime/doc-files/**"/>
    </packageset>
</javadoc>
 
  
  
  </target>
</project>