ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From co...@apache.org
Subject cvs commit: jakarta-ant/docs/manual/OptionalTasks sound.html
Date Tue, 09 Oct 2001 11:12:37 GMT
conor       01/10/09 04:12:37

  Modified:    docs/manual/OptionalTasks Tag: ANT_14_BRANCH sound.html
  Log:
  Fix up sound task documentations to reflect the actual task as it is today
  
  PR:	3998
  Submitted by:	Eric.Smith@NextPage.com (Eric James Smith)
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.2.2.1   +21 -14    jakarta-ant/docs/manual/OptionalTasks/sound.html
  
  Index: sound.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/OptionalTasks/sound.html,v
  retrieving revision 1.2
  retrieving revision 1.2.2.1
  diff -u -w -u -r1.2 -r1.2.2.1
  --- sound.html	2001/02/13 12:31:56	1.2
  +++ sound.html	2001/10/09 11:12:36	1.2.2.1
  @@ -19,6 +19,18 @@
   directory you specify.</p>
   
   <h3>Parameters</h3>
  +<p>(none)</p>
  +
  +<h3>Nested Elements</h3>
  +<h4>success</h4>
  +<p>Specifies the sound to be played if the build succeeded.</p>
  +<h4>fail</h4>
  +<p>Specifies the sound to be played if the build failed.</p>
  +
  +<h3>Nested Element Parameters</h3>
  +<p>
  +The following attributes may be used on the <code>&lt;success&gt;</code>

  +and <code>&lt;fail&gt;</code> elements:</p>
   <table border="1" cellpadding="2" cellspacing="0">
     <tr>
       <td valign="top"><b>Attribute</b></td>
  @@ -26,6 +38,13 @@
       <td align="center" valign="top"><b>Required</b></td>
     </tr>
     <tr>
  +    <td valign="top">source</td>
  +    <td valign="top">the path to a sound-file directory, or the name of a
  +specific sound-file, to be played.
  +    </td>
  +    <td valign="top" align="center">Yes</td>
  +  </tr>
  +  <tr>
       <td valign="top">loops</td>
       <td valign="top">the number of extra times to play the sound-file;
         default is <code>0</code>.
  @@ -40,26 +59,14 @@
       <td valign="top" align="center">No</td>
     </tr>
   </table>
  -<p>
  -To specify the sound-files or the sound-file directories, use the
  -nested <code>&lt;success&gt;</code> and <code>&lt;fail&gt;</code>

  -elements:</p>
  -<blockquote>
  -<pre>
  -&lt;success&gt;     the path to a sound-file directory, or the name of a
  -              specific sound-file, to be played if the build succeeded.
  -&lt;fail&gt;        the path to a sound-file directory, or the name of a
  -              specific sound-file, to be played if the build succeeded.
  -</pre>
  -</blockquote>
   
   <h3>Examples</h3>
   <blockquote>
   <pre>
   &lt;target name=&quot;fun&quot; if=&quot;fun&quot; unless=&quot;fun.done&quot;&gt;
  -  &lt;sound loops=&quot;2&quot;&gt;
  +  &lt;sound&gt;
       &lt;success source=&quot;${user.home}/sounds/bell.wav&quot;/&gt;
  -    &lt;fail source=&quot;${user.home}/sounds/ohno.wav&quot;/&gt;
  +    &lt;fail source=&quot;${user.home}/sounds/ohno.wav&quot; loops=&quot;2&quot;/&gt;
     &lt;/sound&gt;
     &lt;property name=&quot;fun.done&quot; value=&quot;true&quot;/&gt;
   &lt;/target&gt;
  
  
  

Mime
View raw message