peterreilly 2005/03/14 10:14:10
Modified: src/main/org/apache/tools/ant/taskdefs/optional/sound
SoundTask.java
Log:
javadoc
Revision Changes Path
1.18 +12 -0
ant/src/main/org/apache/tools/ant/taskdefs/optional/sound/SoundTask.java
Index: SoundTask.java
===================================================================
RCS file:
/home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/sound/SoundTask.java,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- SoundTask.java 9 Mar 2005 00:20:42 -0000 1.17
+++ SoundTask.java 14 Mar 2005 18:14:10 -0000 1.18
@@ -49,6 +49,7 @@
/**
* add a sound when the build succeeds
+ * @return a BuildAlert to be configured
*/
public BuildAlert createSuccess() {
success = new BuildAlert();
@@ -57,18 +58,26 @@
/**
* add a sound when the build fails
+ * @return a BuildAlert to be configured
*/
public BuildAlert createFail() {
fail = new BuildAlert();
return fail;
}
+ /** Constructor for SoundTask. */
public SoundTask() {
}
+ /**
+ * Initialize the task.
+ */
public void init() {
}
+ /**
+ * Execute the task.
+ */
public void execute() {
AntSoundPlayer soundPlayer = new AntSoundPlayer();
@@ -102,6 +111,7 @@
/**
* Sets the duration in milliseconds the file should be played;
optional.
+ * @param duration the duration in millisconds
*/
public void setDuration(Long duration) {
this.duration = duration;
@@ -127,6 +137,7 @@
/**
* Gets the location of the file to get the audio.
+ * @return the file location
*/
public File getSource() {
File nofile = null;
@@ -170,6 +181,7 @@
/**
* Gets the duration in milliseconds the file should be played.
+ * @return the duration in milliseconds
*/
public Long getDuration() {
return this.duration;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
