Bug 474264 - Adjusted JavaDoc of IJobFunction
Change-Id: Ib0ed4fdfb0041d6dd52568e6bfdec8216b6d542b
diff --git a/bundles/org.eclipse.core.jobs/src/org/eclipse/core/runtime/jobs/IJobFunction.java b/bundles/org.eclipse.core.jobs/src/org/eclipse/core/runtime/jobs/IJobFunction.java
index bacd4c6..e9d6ed3 100644
--- a/bundles/org.eclipse.core.jobs/src/org/eclipse/core/runtime/jobs/IJobFunction.java
+++ b/bundles/org.eclipse.core.jobs/src/org/eclipse/core/runtime/jobs/IJobFunction.java
@@ -20,38 +20,37 @@
* @see Job#create(String, IJobFunction)
* @since 3.6
*/
-
@FunctionalInterface
public interface IJobFunction {
/**
- * Executes this job. Returns the result of the execution.
+ * Executes this job. Returns the result of the execution.
* <p>
* The provided monitor can be used to report progress and respond to
- * cancelation. If the progress monitor has been canceled, the job
- * should finish its execution at the earliest convenience and return a result
- * status of severity {@link IStatus#CANCEL}. The singleton
- * cancel status {@link Status#CANCEL_STATUS} can be used for
- * this purpose. The monitor is only valid for the duration of the invocation
- * of this method.
+ * cancellation. If the progress monitor has been canceled, the job should
+ * finish its execution at the earliest convenience and return a result
+ * status of severity {@link IStatus#CANCEL}. The singleton cancel status
+ * {@link Status#CANCEL_STATUS} can be used for this purpose. The monitor is
+ * only valid for the duration of the invocation of this method.
* <p>
- * This method must not be called directly by clients. Clients should call
+ * This method must not be called directly by clients. Clients should call
* <code>schedule</code>, which will in turn cause this method to be called.
* <p>
- * Jobs can optionally finish their execution asynchronously (in another thread) by
- * returning a result status of {@link Job#ASYNC_FINISH}. Jobs that finish
- * asynchronously <b>must</b> specify the execution thread by calling
- * <code>setThread</code>, and must indicate when they are finished by calling
- * the method <code>done</code>.
+ * Jobs can optionally finish their execution asynchronously (in another
+ * thread) by returning a result status of {@link Job#ASYNC_FINISH}. Jobs
+ * that finish asynchronously <b>must</b> specify the execution thread by
+ * calling {@link Job#setThread(Thread)}, and must indicate when they are
+ * finished by calling the method {@link Job#done(IStatus)}.
*
- * @param monitor the monitor to be used for reporting progress and
- * responding to cancellation. The monitor is never {@code null}.
- * It is the caller's responsibility to call {@link IProgressMonitor#done()}
- * after this method returns or throws an exception.
-
- * @return resulting status of the run. The result must not be {@code null}
+ * @param monitor
+ * the monitor to be used for reporting progress and responding
+ * to cancellation. The monitor is never {@code null}. It is the
+ * caller's responsibility to call
+ * {@link IProgressMonitor#done()} after this method returns or
+ * throws an exception.
+ *
+ * @return resulting status of the run. The result must not be {@code null}.
* @see Job#ASYNC_FINISH
* @see Job#done(IStatus)
*/
public IStatus run(IProgressMonitor monitor);
-
}
