Speedo uses the java (sun TM) code convention except for the indentation. The tab character is used for code indentation.
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
|
||||||||||||||
ouput | contains the built file of the project
|
||||||||||||||||
The following table describes the visible ant targets available in the root build.xml:
clean | clean up the project |
cleandist | clean the distribution |
cleanjar | removes all produced jar files |
cleantest | removes all files produced by the tests |
cleanweb | clean the generated web site |
compile.test | compile tests |
dist | creates all distributions of the product |
help | print the help |
jar | build libraries |
jdoc | build javadocs |
test | run tests |
web | generate 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 |