From 087128d97566731f7766d0e5acd46df147fe0951 Mon Sep 17 00:00:00 2001 From: skyjake Date: Sun, 15 Jan 2012 11:36:12 +0200 Subject: [PATCH] Documentation: Better summary of the Busy Mode --- doomsday/engine/portable/include/con_busy.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doomsday/engine/portable/include/con_busy.h b/doomsday/engine/portable/include/con_busy.h index bf14017175..01ac288ffe 100644 --- a/doomsday/engine/portable/include/con_busy.h +++ b/doomsday/engine/portable/include/con_busy.h @@ -4,9 +4,12 @@ * * @ingroup console * - * Draws the screen while the main engine thread is working a long - * operation. The busy mode can be configured to be displaying a progress - * bar, the console output, or a more generic "please wait" message. + * The Busy Mode is intended for long-running tasks that would otherwise block + * the main engine (UI) thread. During busy mode, a progress screen is shown by + * the main thread while a background thread works on a long operation. The + * normal Doomsday UI cannot be interacted with while the task is running. The + * busy mode can be configured to show a progress bar, the console output, + * and/or a description of the task being carried out. * * @authors Copyright © 2009-2012 Jaakko Keränen * @authors Copyright © 2009-2012 Daniel Swanson