Various Doxygen fixes.

[dcpomatic.git] / src / lib / job.cc

diff --git a/src/lib/job.cc b/src/lib/job.cc
index dba21f91cdf031362116468df543cca9eda19062..31f336b6565500633c5479e1d01ba85c155a927f 100644 (file)
--- a/src/lib/job.cc
+++ b/src/lib/job.cc
@@ -239,10 +239,17 @@ Job::finished_cancelled () const
 }
 
 bool
-Job::paused () const
+Job::paused_by_user () const
 {
        boost::mutex::scoped_lock lm (_state_mutex);
-       return _state == PAUSED;
+       return _state == PAUSED_BY_USER;
+}
+
+bool
+Job::paused_by_priority () const
+{
+       boost::mutex::scoped_lock lm (_state_mutex);
+       return _state == PAUSED_BY_PRIORITY;
 }
 
 /** Set the state of this job.
@@ -287,7 +294,7 @@ Job::check_for_interruption_or_pause ()
        boost::this_thread::interruption_point ();
 
        boost::mutex::scoped_lock lm (_state_mutex);
-       while (_state == PAUSED) {
+       while (_state == PAUSED_BY_USER || _state == PAUSED_BY_PRIORITY) {
                emit (boost::bind (boost::ref (Progress)));
                _pause_changed.wait (lm);
        }
@@ -295,6 +302,7 @@ Job::check_for_interruption_or_pause ()
 
 /** Set the progress of the current part of the job.
  *  @param p Progress (from 0 to 1)
+ *  @param force Do not ignore this update, even if it hasn't been long since the last one.
  */
 void
 Job::set_progress (float p, bool force)
@@ -367,7 +375,8 @@ Job::error_summary () const
 }
 
 /** Set the current error string.
- *  @param e New error string.
+ *  @param s New error string.
+ *  @param d New error detail string.
  */
 void
 Job::set_error (string s, string d)
@@ -450,7 +459,8 @@ Job::json_status () const
                return N_("new");
        case RUNNING:
                return N_("running");
-       case PAUSED:
+       case PAUSED_BY_USER:
+       case PAUSED_BY_PRIORITY:
                return N_("paused");
        case FINISHED_OK:
                return N_("finished_ok");
@@ -481,7 +491,7 @@ Job::cancel ()
                return;
        }
 
-       if (paused ()) {
+       if (paused_by_user() || paused_by_priority()) {
                resume ();
        }
 
@@ -493,10 +503,19 @@ Job::cancel ()
 }
 
 void
-Job::pause ()
+Job::pause_by_user ()
+{
+       if (running ()) {
+               set_state (PAUSED_BY_USER);
+               _pause_changed.notify_all ();
+       }
+}
+
+void
+Job::pause_by_priority ()
 {
        if (running ()) {
-               set_state (PAUSED);
+               set_state (PAUSED_BY_PRIORITY);
                _pause_changed.notify_all ();
        }
 }
@@ -504,7 +523,7 @@ Job::pause ()
 void
 Job::resume ()
 {
-       if (paused ()) {
+       if (paused_by_user() || paused_by_priority()) {
                set_state (RUNNING);
                _pause_changed.notify_all ();
        }