basic Netbeans project files and enriched build documentation: fixes JAL-848
[jalview.git] / nbbuild.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- You may freely edit this file. See commented blocks below for -->
3 <!-- some examples of how to customize the build. -->
4 <!-- (If you delete it and reopen the project it will be recreated.) -->
5 <!-- By default, only the Clean and Build commands use this build script. -->
6 <!-- Commands such as Run, Debug, and Test only use this build script if -->
7 <!-- the Compile on Save feature is turned off for the project. -->
8 <!-- You can turn off the Compile on Save (or Deploy on Save) setting -->
9 <!-- in the project's Project Properties dialog box.-->
10 <project name="jalview" default="default" basedir=".">
11     <description>Builds, tests, and runs the project jalview.</description>
12     <import file="nbproject/build-impl.xml"/>
13     <target name="-pre-compile">
14         <ant antfile="build.xml" target="buildindices">
15         <property name="outputDir" value="build/classes"/>    
16         <property name="packageDir" value="build/dist"/>    
17         </ant>
18         
19     </target>
20     <!--
21
22     There exist several targets which are by default empty and which can be 
23     used for execution of your tasks. These targets are usually executed 
24     before and after some main targets. They are: 
25
26       -pre-init:                 called before initialization of project properties
27       -post-init:                called after initialization of project properties
28       -pre-compile:              called before javac compilation
29       -post-compile:             called after javac compilation
30       -pre-compile-single:       called before javac compilation of single file
31       -post-compile-single:      called after javac compilation of single file
32       -pre-compile-test:         called before javac compilation of JUnit tests
33       -post-compile-test:        called after javac compilation of JUnit tests
34       -pre-compile-test-single:  called before javac compilation of single JUnit test
35       -post-compile-test-single: called after javac compilation of single JUunit test
36       -pre-jar:                  called before JAR building
37       -post-jar:                 called after JAR building
38       -post-clean:               called after cleaning build products
39
40     (Targets beginning with '-' are not intended to be called on their own.)
41
42     Example of inserting an obfuscator after compilation could look like this:
43
44         <target name="-post-compile">
45             <obfuscate>
46                 <fileset dir="${build.classes.dir}"/>
47             </obfuscate>
48         </target>
49
50     For list of available properties check the imported 
51     nbproject/build-impl.xml file. 
52
53
54     Another way to customize the build is by overriding existing main targets.
55     The targets of interest are: 
56
57       -init-macrodef-javac:     defines macro for javac compilation
58       -init-macrodef-junit:     defines macro for junit execution
59       -init-macrodef-debug:     defines macro for class debugging
60       -init-macrodef-java:      defines macro for class execution
61       -do-jar-with-manifest:    JAR building (if you are using a manifest)
62       -do-jar-without-manifest: JAR building (if you are not using a manifest)
63       run:                      execution of project 
64       -javadoc-build:           Javadoc generation
65       test-report:              JUnit report generation
66
67     An example of overriding the target for project execution could look like this:
68
69         <target name="run" depends="jalview-impl.jar">
70             <exec dir="bin" executable="launcher.exe">
71                 <arg file="${dist.jar}"/>
72             </exec>
73         </target>
74
75     Notice that the overridden target depends on the jar target and not only on 
76     the compile target as the regular run target does. Again, for a list of available 
77     properties which you can use, check the target you are overriding in the
78     nbproject/build-impl.xml file. 
79
80     -->
81 </project>