Use ant to create docs

This commit is contained in:
Christopher Eby 2011-10-25 17:41:51 -05:00
parent 924205bbad
commit bc1f587730
4 changed files with 95 additions and 7 deletions

1
.gitignore vendored
View File

@ -2,7 +2,6 @@
bin
gen
.*
build.xml
local.properties
*.ipr
*.iws

2
README
View File

@ -3,3 +3,5 @@ Vanilla Music Player is a music player for Android
To build, assuming you have the Android SDK installed and in your path:
android update project --name VanillaMusic --path .
ant debug (or ant release)
Javadocs can be generated using 'ant doc'

93
build.xml Normal file
View File

@ -0,0 +1,93 @@
<?xml version="1.0" encoding="UTF-8"?>
<project name="VanillaMusic" default="help">
<!-- The local.properties file is created and updated by the 'android' tool.
It contains the path to the SDK. It should *NOT* be checked into
Version Control Systems. -->
<loadproperties srcFile="local.properties" />
<!-- The ant.properties file can be created by you. It is only edited by the
'android' tool to add properties to it.
This is the place to change some Ant specific build properties.
Here are some properties you may want to change/update:
source.dir
The name of the source directory. Default is 'src'.
out.dir
The name of the output directory. Default is 'bin'.
For other overridable properties, look at the beginning of the rules
files in the SDK, at tools/ant/build.xml
Properties related to the SDK location or the project target should
be updated using the 'android' tool with the 'update' action.
This file is an integral part of the build system for your
application and should be checked into Version Control Systems.
-->
<property file="ant.properties" />
<!-- The project.properties file is created and updated by the 'android'
tool, as well as ADT.
This contains project specific properties such as project target, and library
dependencies. Lower level build properties are stored in ant.properties
(or in .classpath for Eclipse projects).
This file is an integral part of the build system for your
application and should be checked into Version Control Systems. -->
<loadproperties srcFile="project.properties" />
<!-- quick check on sdk.dir -->
<fail
message="sdk.dir is missing. Make sure to generate local.properties using 'android update project'"
unless="sdk.dir"
/>
<!-- extension targets. Uncomment the ones where you want to do custom work
in between standard targets -->
<!--
<target name="-pre-build">
</target>
<target name="-pre-compile">
</target>
/* This is typically used for code obfuscation.
Compiled code location: ${out.classes.absolute.dir}
If this is not done in place, override ${out.dex.input.absolute.dir} */
<target name="-post-compile">
</target>
-->
<!-- Import the actual build file.
To customize existing targets, there are two options:
- Customize only one target:
- copy/paste the target into this file, *before* the
<import> task.
- customize it to your needs.
- Customize the whole content of build.xml
- copy/paste the content of the rules files (minus the top node)
into this file, replacing the <import> task.
- customize to your needs.
***********************
****** IMPORTANT ******
***********************
In all cases you must update the value of version-tag below to read 'custom' instead of an integer,
in order to avoid having your file be overridden by tools such as "android update project"
-->
<!-- version-tag: 1 -->
<import file="${sdk.dir}/tools/ant/build.xml" />
<target name="doc" depends="-setup">
<javadoc
destdir="doc"
sourcepath="${source.dir}"
bootclasspathref="android.target.classpath"
access="private" />
</target>
</project>

6
doc.sh
View File

@ -1,6 +0,0 @@
#!/bin/sh
sdk=`grep sdk.dir= local.properties`
sdk=${sdk#sdk.dir=}
target=`grep target= project.properties`
target=${target#target=}
exec javadoc -classpath "$sdk/platforms/$target/android.jar" -d doc -sourcepath src -private org.kreed.vanilla