Salome HOME
Update classes documentation
[modules/shaper.git] / src / ModuleBase / ModuleBase_Dialog.h
index 6b3074de5605d9fffa23d70461731ceafda3efab..bb58343f6b9fcb054810d7c54f189a6ec99526fc 100644 (file)
@@ -21,23 +21,41 @@ class ModuleBase_Dialog : public QDialog
 {
   Q_OBJECT
 public:
+  /// Constructor
+  /// \param theParent a workshop object instance
+  /// \param theId an Id of a feature
+  /// \param theDescription an XML description of the feature
   ModuleBase_Dialog(ModuleBase_IWorkshop* theParent, const QString& theId, 
                     const std::string& theDescription);
 
+  /// Redefinition of virtual method
   virtual void accept();
 
 protected:
+  /// Redefinition of virtual method
   virtual void showEvent(QShowEvent* theEvent);
 
 
 private:
+  /// Initialising of the widget
   void initializeWidget(ModuleBase_ModelWidget* theWidget);
 
+  /// Id of the feature
   QString myId;
+
+  /// XML description of the feature
   std::string myDescription;
+
+  /// An instance of workshop object
   ModuleBase_IWorkshop* myWorkshop;
+
+  /// The feature instance
   FeaturePtr myFeature;
+
+  /// List of created widgets
   QList<ModuleBase_ModelWidget*> myWidgets;
+
+  /// Pointer on active widget
   ModuleBase_ModelWidget* myActiveWidget;
 };