From 38012f90328622b1b395fc6ff6c3b790f290c0be Mon Sep 17 00:00:00 2001 From: nds Date: Fri, 18 Sep 2015 20:02:42 +0300 Subject: [PATCH] Comments of the code. --- src/ModuleBase/ModuleBase_PagedContainer.h | 4 ++++ src/ModuleBase/ModuleBase_WidgetToolbox.h | 6 +++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/src/ModuleBase/ModuleBase_PagedContainer.h b/src/ModuleBase/ModuleBase_PagedContainer.h index 8d7511d2b..59730cd7d 100644 --- a/src/ModuleBase/ModuleBase_PagedContainer.h +++ b/src/ModuleBase/ModuleBase_PagedContainer.h @@ -13,6 +13,10 @@ class ModuleBase_PageBase; +/** +* \ingroup GUI +* This is an abstract interface to be used for not model container widget such as switch or tool box. +*/ class MODULEBASE_EXPORT ModuleBase_PagedContainer : public ModuleBase_ModelWidget { Q_OBJECT diff --git a/src/ModuleBase/ModuleBase_WidgetToolbox.h b/src/ModuleBase/ModuleBase_WidgetToolbox.h index 348ecb248..44565db2c 100644 --- a/src/ModuleBase/ModuleBase_WidgetToolbox.h +++ b/src/ModuleBase/ModuleBase_WidgetToolbox.h @@ -14,6 +14,10 @@ class ModuleBase_PageBase; class ModuleBase_ToolBox; +/** +* \ingroup GUI +* Implements a model widget for switch as a container widget. It can be defined in XML with "toolbox" keyword +*/ class MODULEBASE_EXPORT ModuleBase_WidgetToolbox : public ModuleBase_PagedContainer { Q_OBJECT @@ -23,7 +27,7 @@ class MODULEBASE_EXPORT ModuleBase_WidgetToolbox : public ModuleBase_PagedContai virtual ~ModuleBase_WidgetToolbox(); /// Defines if it is supported to set the value in this widget - /// It returns false because this is an info widget + /// \return false because this is an info widget virtual bool canSetValue() const { return false; }; /// Overrides ModuleBase_PagedContainer -- 2.39.2