buildframework/helium/sf/java/signaling/src/com/nokia/helium/signal/ant/types/SignalInput.java
changeset 628 7c4a911dc066
parent 587 85df38eb4012
child 645 b8d81fa19e7d
--- a/buildframework/helium/sf/java/signaling/src/com/nokia/helium/signal/ant/types/SignalInput.java	Wed Jun 16 16:51:40 2010 +0300
+++ b/buildframework/helium/sf/java/signaling/src/com/nokia/helium/signal/ant/types/SignalInput.java	Fri Aug 13 14:59:05 2010 +0300
@@ -21,21 +21,29 @@
 
 import java.util.Vector;
 
+import org.apache.log4j.Logger;
+import org.apache.tools.ant.BuildException;
 import org.apache.tools.ant.types.DataType;
-import com.nokia.helium.core.ant.types.ReferenceType;
-import org.apache.log4j.Logger;
 
+import com.nokia.helium.core.ant.types.ReferenceType;
 import com.nokia.helium.signal.Notifier;
 
-import org.apache.tools.ant.BuildException;
-
 /**
  * SignalInput class which is a type to store input for signals
  * Signals..
- * <targetCondition>
- *    <hasSeverity severity="error" file="${build.cache.log.dir}/signals/prep_work_status.xml" />
- * </targetCondition>
+ *   
+ * <pre>
+ *   &lt;hlm:signalInput id=&quot;testDeferredSignalInput&quot;&gt;
+ *      &lt;/hlm:notifierList refid=&quot;defaultNotiferList&quot; &gt;
+ *   &lt;/hlm:signalInput&gt;
+ *   
+ *   &lt;hlm:signal name=&quot;compileSignal&quot; result=&quot;${result}&quot;&gt;
+ *       &lt;-- Let's refer to some existing signal input configuration --&gt;
+ *       &lt;hlm:signalInput refid=&quot;testDeferredSignalInput&quot; /&gt;
+ *   &lt;/hlm:signal&gt;
+ * </pre>
  * 
+ * @ant.type name="signalInput" category="Signaling"
  */
 public class SignalInput extends DataType
 {
@@ -50,8 +58,11 @@
 
     
     /**
-     * Helper function called by ant to set the failbuild type
+     * Defines how the signal framework should handle the error, either
+     * fail "now", at the end of the build "defer", or ignore the failure
+     * with "never".
      * @param failBuild type of failure for this input.
+     * @ant.not-required Default is now.
      */
     public void setFailBuild(FailBuildEnum failInput) {
         failBuild = failInput.getValue();
@@ -115,7 +126,6 @@
      * Gets the NotifierList associated with this input. If the
      * notifier list reference is empty then it throws exception. 
      * @return List of notifier associated with this input.
-     * @throws HlmAntLibException
      */    
     public Vector<Notifier> getSignalNotifierList() {
         Vector<Notifier> notifierList = null;