clarify some comments regarding GUI start

This commit is contained in:
Fischlurch 2010-02-13 17:41:16 +01:00
parent 4e31db5a74
commit acd0671390
3 changed files with 13 additions and 6 deletions

View file

@ -48,6 +48,7 @@ namespace gui {
/** load and start the GUI as a plugin */
struct GuiRunner
: public GuiFacade
{
@ -78,7 +79,7 @@ namespace gui {
namespace { // implementation details : start GUI through GuiStarterPlugin
namespace { // implementation of GUI-"Subsystem" : start GUI through GuiStarterPlugin
scoped_ptr<GuiRunner> facade (0);

View file

@ -60,11 +60,16 @@ namespace gui {
* When running Lumiera with a GUI is required (the default case),
* it is loaded as dynamic module, thus defining the interface(s)
* for any further access. After successfully loading and starting
* the GUI, this gui::Facade is wired internally with this interface
* such as to allow transparent access from within the core. This
* startup sequence includes providing the GUI with similar facade
* access via interface handles for communication with Backend and
* Proc-Layer.
* the GUI, the actual "business" interfaces of the GUI are opened
* and wired internally such as to allow transparent access from
* within the core.
*
* \par implementation notes
* This is an facade interface to the GUI subsystem, but it is setup
* somewhat special, as its sole purpose is to expose the subsystem
* descriptor, which, when started, loads the GUI as a plugin and
* invokes \c kickOff(term) there. For the implementation see
* gui::GuiRunner (guifacade.cpp) and guistart.cpp (the plugin).
*
* @note this facade is intended to be used by Lumiera main solely.
* client code should always use the "business" interface(s).

View file

@ -26,6 +26,7 @@
** usable by scripts or the two lower layers. The main purpose of these services
** is to push informations and status updates into the GUI.
**
** @see notification-service.hpp implementation
** @see gui::GuiFacade
** @see main.cpp
*/