Fixing javadoc for spring-quartz

apache · Nov 27, 2019 · cba6a1c · cba6a1c
1 parent 90ef91a
commit cba6a1c
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 11 deletions.
diff --git a/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/AbstractJob.java b/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/AbstractJob.java
@@ -70,6 +70,7 @@ public abstract class AbstractJob
 
     /**
      * Set Job Data Map
+     * @param jobDataMap the data map
      */
     public void setJobDataMap( JobDataMap jobDataMap )
     {
@@ -78,6 +79,7 @@ public void setJobDataMap( JobDataMap jobDataMap )
 
     /**
      * Get Job Data Map
+     * @return the data map
      */
     public JobDataMap getJobDataMap()
     {
@@ -86,6 +88,7 @@ public JobDataMap getJobDataMap()
 
     /**
      * Get the Logger.
+     * @return the logger set for this job
      */
     public Logger getLogger()
     {

diff --git a/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/DefaultJobListener.java b/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/DefaultJobListener.java
@@ -35,21 +35,17 @@ public class DefaultJobListener
     implements JobListener
 {
     /**
-     * <p>
-     * <p/>
-     * Get the name of the <code>JobListener</code>.</p>
+     * Get the name of the <code>JobListener</code>.
      */
     public String getName()
     {
         return "DefaultJobLister";
     }
 
     /**
-     * <p>
-     * <p/>
      * Called by the <code>{@link Scheduler}</code> when a <code>{@link Job}</code>
      * is about to be executed (an associated <code>{@link org.quartz.Trigger}</code> has
-     * occured).</p>
+     * occured).
      */
     public void jobToBeExecuted( JobExecutionContext context )
     {
@@ -68,11 +64,9 @@ public void jobExecutionVetoed( JobExecutionContext jobExecutionContext )
     }
 
     /**
-     * <p>
-     * <p/>
      * Called by the <code>{@link Scheduler}</code> after a <code>{@link Job}</code>
      * has been executed, and be for the associated <code>Trigger</code>'s
-     * <code>triggered(xx)</code> method has been called.</p>
+     * <code>triggered(xx)</code> method has been called.
      */
     public void jobWasExecuted( JobExecutionContext context, JobExecutionException jobException )
     {

diff --git a/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/Scheduler.java b/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/Scheduler.java
@@ -34,13 +34,17 @@ void scheduleJob( JobDetail jobDetail, Trigger trigger )
         throws SchedulerException;
 
     /**
-     * @param listener
+     * Adds the job listener
+     * @param listener listener instance
+     * @throws SchedulerException if the listener could not be registered
      */
     void addGlobalJobListener( JobListener listener )
         throws SchedulerException;
 
     /**
-     * @param listener
+     * Adds a job trigger listener
+     * @param listener the listener instance
+     * @throws SchedulerException if the listener could not be registered
      */
     void addGlobalTriggerListener( TriggerListener listener )
         throws SchedulerException;