CSE 70, Spring 2008
Software Engineering
Lab 5 Instructions
Goal
To add a step to the automatic build cycle using Apache Ant.
Generating documentation with javadoc
Make sure that your build file is called build.xml and located inside trunk. The build file has three main types of elements:
- <property> What do they define? Can their value be reused? How?
- <path> What do they define?
- <target> What do they define? How can they be related?
* TASK: Generate documentation for your project in a directory called doc.
- To do this you will need to run javadoc with command-line arguments specifying the source directory, the destination directory, and the name of the package.
- You may want to refer to this command-line example (which has a lot more options than you need).
* TASK: Modify your build.xml so that running ant javadoc will automatically generate documentation for your project in the doc directory. You should add a target called javadoc, with the appropriate task within it.
- You should refer to the description of the Javadoc Task in Ant.
- Make sure you can delete your entire doc directory and regenerate the documentation using ant javadoc!
Before you leave!
- Show the course staff that you have checked in an updated build.xml with an Ant target to generate documentation for your project in the doc directory.