Commit 10a723e5 authored by Alexander Wiebel's avatar Alexander Wiebel
Browse files

[DOC #327] fixed some documentation related stuff after remaining after GUI UI renaming

parent e6a2e3ec
......@@ -81,7 +81,7 @@ ENDIF()
ADD_CUSTOM_TARGET( list_install_tarets
COMMAND echo The following components can be installed:
COMMAND echo " * install - install everything."
COMMAND echo " * install_runtime - install the GUIs."
COMMAND echo " * install_runtime - install the UIs."
COMMAND echo " * install_lib - install only libopenwalnut."
COMMAND echo " * install_modules - install only the compiled modules."
COMMAND echo " * install_dev - install the development headers for libopenwalnut."
......@@ -146,10 +146,10 @@ IF( OW_GUI_QT4 )
ENDIF()
# -----------------------------------------------------------------------------------------------------------------------------------------------
# Scripting GUI
# Scripting UI
OPTION( OW_GUI_SCRIPT "Enable this to build the script-based OpenWalnut interface for commandline-only use." ON )
IF( OW_GUI_SCRIPT )
OPTION( OW_UI_SCRIPT "Enable this to build the script-based OpenWalnut interface for commandline-only use." ON )
IF( OW_UI_SCRIPT )
# build
ADD_SUBDIRECTORY( scriptUI )
ENDIF()
......
......@@ -36,16 +36,16 @@
class WDataSet;
/**
* This library implements the graphical user interface for OpenWalnut.
* This library implements the user interface for OpenWalnut.
*
* \defgroup gui GUI
* \defgroup ui UI
*/
/**
* This class prescribes the interface to the GUI. It basically is an abstract class defining the interface common to all possible
* GUI implementations.
* This class prescribes the interface to the UI. It basically is an abstract class defining the interface common to all possible
* UI implementations.
*
* \ingroup gui
* \ingroup ui
*/
class WUI : public boost::enable_shared_from_this< WUI >
{
......@@ -71,7 +71,7 @@ public:
virtual const WFlag< bool >& isInitialized() const;
/**
* Runs the GUI. All initialization should be done here.
* Runs the UI. All initialization should be done here.
*
* \return the return code.
*/
......@@ -111,7 +111,7 @@ public:
protected:
/**
* Flag determining whether the GUI is properly initialized.
* Flag determining whether the UI is properly initialized.
*/
WFlag< bool > m_isInitialized;
......
......@@ -59,7 +59,7 @@ class WQtGLScreenCapture;
/**
* This class contains the main window and the layout of the widgets within the window.
* \ingroup gui
* \ingroup ui
*/
class WMainWindow : public QMainWindow
{
......
......@@ -48,7 +48,7 @@ class WKernel;
/**
* The QT4 Based GUI implementation. Implements WUI.
* \ingroup gui
* \ingroup ui
*/
class WQt4Gui : public WUI
{
......
......@@ -54,7 +54,7 @@ class WSettingAction;
/**
* A widget containing an open gl display area. This initializes OpenGL context and adds a view to the
* engine.
* \ingroup gui
* \ingroup ui
*/
// NOTE: to make this work with MOC, the defines must be set before MOC runs (ensured in Build system)
class WQtGLWidget: public WQtGLWidgetParent
......
......@@ -34,8 +34,10 @@
/**
* \class WScriptUI
*
* Implements a gui that executes scripts. These can be read from files or input by the user,
* Implements a UI that executes scripts. These can be read from files or input by the user,
* depending on the parameters supplied to the executable.
*
* \ingroup ui
*/
class WScriptUI : public WUI
{
......@@ -55,7 +57,7 @@ public:
virtual ~WScriptUI();
/**
* Runs the GUI.
* Runs the UI.
*
* \return the return code.
*/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment