svn commit: r1041157 - in /servicemix/components/engines/servicemix-quartz/trunk: pom.xml src/main/java/org/apache/servicemix/quartz/QuartzEndpoint.java

[ge...@apache.org]

Author: gertv
Date: Wed Dec  1 20:40:14 2010
New Revision: 1041157

URL: http://svn.apache.org/viewvc?rev=1041157&view=rev
Log:
Add better javadocs to improve generated wiki/xsd documentation

Modified:
    servicemix/components/engines/servicemix-quartz/trunk/pom.xml
    servicemix/components/engines/servicemix-quartz/trunk/src/main/java/org/apache/servicemix/quartz/QuartzEndpoint.java

Modified: servicemix/components/engines/servicemix-quartz/trunk/pom.xml
URL: http://svn.apache.org/viewvc/servicemix/components/engines/servicemix-quartz/trunk/pom.xml?rev=1041157&r1=1041156&r2=1041157&view=diff
==============================================================================
--- servicemix/components/engines/servicemix-quartz/trunk/pom.xml (original)
+++ servicemix/components/engines/servicemix-quartz/trunk/pom.xml Wed Dec  1 20:40:14 2010
@@ -134,6 +134,13 @@
                 </exclusion>
             </exclusions>
         </dependency>
+
+        <!-- documentation -->
+        <dependency>
+            <groupId>org.apache.servicemix</groupId>
+            <artifactId>servicemix-common</artifactId>
+            <classifier>sources</classifier>
+        </dependency>      
     </dependencies>
 
     <build>

Modified: servicemix/components/engines/servicemix-quartz/trunk/src/main/java/org/apache/servicemix/quartz/QuartzEndpoint.java
URL: http://svn.apache.org/viewvc/servicemix/components/engines/servicemix-quartz/trunk/src/main/java/org/apache/servicemix/quartz/QuartzEndpoint.java?rev=1041157&r1=1041156&r2=1041157&view=diff
==============================================================================
--- servicemix/components/engines/servicemix-quartz/trunk/src/main/java/org/apache/servicemix/quartz/QuartzEndpoint.java (original)
+++ servicemix/components/engines/servicemix-quartz/trunk/src/main/java/org/apache/servicemix/quartz/QuartzEndpoint.java Wed Dec  1 20:40:14 2010
@@ -62,6 +62,8 @@ public class QuartzEndpoint extends Cons
     }
 
     /**
+     * A list of of {@link org.quartz.Trigger} instances to allow configuring multiple schedules for the same endpoint.
+     *
      * @param triggers the triggers to set
      */
     public void setTriggers(List<Trigger> triggers) {
@@ -76,6 +78,8 @@ public class QuartzEndpoint extends Cons
     }
 
     /**
+     * A single {@link org.quartz.Trigger} instance to define the trigger schedule.
+     *
      * @param trigger the trigger to set
      */
     public void setTrigger(Trigger trigger) {
@@ -90,6 +94,8 @@ public class QuartzEndpoint extends Cons
     }
 
     /**
+     * A map with {@link org.quartz.Calendar} instances to define the trigger schedule.
+     *
      * @param calendar the calendar to set
      */
     public void setCalendars(Map<String, Calendar> calendars) {
@@ -104,6 +110,8 @@ public class QuartzEndpoint extends Cons
     }
 
     /**
+     * Set a custom JobDetail bean to be used in the triggered events.
+     *
      * @param job the job to set
      */
     public void setJobDetail(JobDetail job) {
@@ -114,6 +122,11 @@ public class QuartzEndpoint extends Cons
         return marshaler;
     }
 
+    /**
+     * Set a custom marshaler class to translate the JobDetail information into a normalized message.
+     *
+     * @param marshaler
+     */
     public void setMarshaler(QuartzMarshaler marshaler) {
         this.marshaler = marshaler;
     }