Speedo developer documentation



Code convention

Speedo uses the java (sun TM) code convention except for the indentation. The tab character is used for code indentation.


Building process

The building process is based on a common project structre and the use of Ant. The following table describes the project structure

build.xml "the root build.xml permiting to do all process
src contains the source file of the project.
externals contains the external libraries required to compile, test, and run the product
archive contains ant files creating the libraries of the project. By convention there is one ant file by librairies. The name of the ant file is based on the name of the created library.
jdoc contains ant files creating the javadocs of the project. In a project it is possible to create several javadoc, one for user and one for developer for instance. By convention there is one ant file by built javadoc
doc contains the documentation of the project
etc contains the configuration file of the project
dist contains the file to copy into the distribution (output/dist)
test contains the test of the product
*.xmlant files permitting to launch a test
commoncontains common source of all tests
conformcontains source of conformance tests
ouput contains the built file of the project
buildcontains the compiled classes of the product
testcontains the compiled classes of the tests, and the test results.
tmpcontains temporaly file for building process
distcontains the distribution
etccontains the configuration file of the project (copied from /etc)
libcontains the libraries of project and the librairies of dependencies (copied from externals)
doccontains the documentation of the project (copied from doc) and the javadocs
zipcontains the zip and tgz file of the project and the distribution

The root ant file

The following table describes the visible ant targets available in the root build.xml:

cleanclean up the project
cleandistclean the distribution
cleanjarremoves all produced jar files
cleantestremoves all files produced by the tests
cleanwebclean the generated web site
compile.testcompile tests
distcreates all distributions of the product
helpprint the help
jar build libraries
jdoc build javadocs
testrun tests
webgenerate the web site
whichtest list all test launcher (xml files)
zip creates zip files of the different distribution (source, binaries)
rar creates big archives of Speedo