Improve job manager docs [ci skip]

Signed-off-by: Paolo Di Tommaso <[email protected]>
seqeralabs · Dec 1, 2024 · daae53d · daae53d
1 parent 6fb214a
commit daae53d
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/main/groovy/io/seqera/wave/service/job/JobManager.groovy b/src/main/groovy/io/seqera/wave/service/job/JobManager.groovy
@@ -73,6 +73,16 @@ class JobManager {
         queue.addConsumer((job)-> processJob(job))
     }
 
+    /**
+     * Process a job entry aorrding the state modelled by the {@link JobSpec} object.
+     *
+     * @param jobSpec
+     *      A {@link JobSpec} object representing the job to be processed
+     * @return
+     *      {@code true} to signal the process has been processed successfully and it should
+     *      be removed from the underlying queue, or {@code false} if the job execution has
+     *      not yet completed.
+     */
     protected boolean processJob(JobSpec jobSpec) {
         try {
             return processJob0(jobSpec)