diff options
author | Campbell Barton <ideasman42@gmail.com> | 2015-06-01 07:56:07 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2015-06-01 07:56:07 +0300 |
commit | 565faadd8ef6bb44d04ac3ff4e8438d21da3383e (patch) | |
tree | b9289a85cb0947e8173341525957d4f72b48d7bf /source/blender/windowmanager/intern/wm_jobs.c | |
parent | 668f1f95543ab466403f473ccd01ff41461896f5 (diff) |
Cleanup: doxygen comments
Diffstat (limited to 'source/blender/windowmanager/intern/wm_jobs.c')
-rw-r--r-- | source/blender/windowmanager/intern/wm_jobs.c | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/source/blender/windowmanager/intern/wm_jobs.c b/source/blender/windowmanager/intern/wm_jobs.c index 6bc858e861a..f8258d18c1a 100644 --- a/source/blender/windowmanager/intern/wm_jobs.c +++ b/source/blender/windowmanager/intern/wm_jobs.c @@ -157,8 +157,8 @@ static void wm_job_main_thread_yield(wmJob *wm_job, bool ending) BLI_ticket_mutex_lock(wm_job->main_thread_mutex); } -/* finds: - * if type or owner, compare for it, otherwise any matching job +/** + * Finds if type or owner, compare for it, otherwise any matching job. */ static wmJob *wm_job_find(wmWindowManager *wm, void *owner, const int job_type) { @@ -185,9 +185,12 @@ static wmJob *wm_job_find(wmWindowManager *wm, void *owner, const int job_type) /* ******************* public API ***************** */ -/* returns current or adds new job, but doesnt run it */ -/* every owner only gets a single job, adding a new one will stop running job and - * when stopped it starts the new one */ +/** + * \return current job or adds new job, but doesnt run it. + * + * \note every owner only gets a single job, + * adding a new one will stop running job and when stopped it starts the new one. + */ wmJob *WM_jobs_get(wmWindowManager *wm, wmWindow *win, void *owner, const char *name, int flag, int job_type) { wmJob *wm_job = wm_job_find(wm, owner, job_type); @@ -375,8 +378,10 @@ static void wm_jobs_test_suspend_stop(wmWindowManager *wm, wmJob *test) // if (suspend) printf("job suspended: %s\n", test->name); } -/* if job running, the same owner gave it a new job */ -/* if different owner starts existing startjob, it suspends itself */ +/** + * if job running, the same owner gave it a new job. + * if different owner starts existing startjob, it suspends itself + */ void WM_jobs_start(wmWindowManager *wm, wmJob *wm_job) { if (wm_job->running) { |