DEFAULT BEHAVIOR:

When writing JavaDoc for a method that accepts an IProgressMonitor, you should assume the following default behavior unless the method's JavaDoc says otherwise:

    * It WILL call beginTask on the IProgressMonitor.
    * It WILL NOT accept a null argument.
    * It WILL call done on the IProgressMonitor.

BEST PRACTISES:

We recommend that newly-written methods follow the given contract:

    * It WILL call beginTask on the IProgressMonitor.
    * It WILL accept a null argument, indicating that no progress should be reported and the operation cannot be cancelled.
    * It WILL NOT call done on the IProgressMonitor, leaving this responsibility up to the caller.

If you wish to follow these conventions, you may copy and paste the following text into your method's JavaDoc: