makefile/preflighting/javadoc.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

<?xml version="1.0" encoding="UTF-8"?>

<project name="JavaDoc">
    
	<!-- Here are expected the following properties:
	
			sourceCodeDirectories = Semi-colon separated directories which holds the classes where the Javadocs will
								 be generated from.
								
			excludePackages = Packages which are to be excluded from the generated Javadoc document.
								 
			javadocOutputDirectory = The directory where the generated Javadocs will be placed.
			
			javaAPIPackageLocationDirectory = The directory location of the API reference file. The file must
											  be named package-list.
											  
			javaAPIURLDirectory = The URL of the Java API. 	
	 -->
	
    <target name="javadoc">
		<javadoc packagenames="*.*"
		           sourcepath="${sourceCodeDirectories}"
				   excludepackagenames="${excludePackages}"
		           defaultexcludes="yes"
		           destdir="${javadocOutputDirectory}"
		           author="false"
		           version="true"
		           use="true"
		           windowtitle="App Validator Javadoc">
			<link offline="true" href="${javaAPIURLDirectory}" packagelistloc="${javaAPIPackageLocationDirectory}" />
		    <doctitle><![CDATA[<h1>App Validator</h1>]]></doctitle>
			<bottom><![CDATA[<i>Copyright &#169; 2011, Motorola Mobility, Inc. All rights reserved.</i>]]></bottom>
		  </javadoc>
	</target>
</project>