From: ouv <ouv@opencascade.com>
Date: Fri, 11 Nov 2005 15:04:47 +0000 (+0000)
Subject: Documentation.
X-Git-Tag: BR-D5-38-2003_D2005-24-11~48
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=d4f3960bb3a34eaf0eebb14b6c0e9b58dc8717a9;p=modules%2Fvisu.git

Documentation.
---

diff --git a/src/VISUGUI/VisuGUI_GaussPointsDlg.h b/src/VISUGUI/VisuGUI_GaussPointsDlg.h
index 772367b2..82b24e87 100644
--- a/src/VISUGUI/VisuGUI_GaussPointsDlg.h
+++ b/src/VISUGUI/VisuGUI_GaussPointsDlg.h
@@ -52,6 +52,8 @@ namespace VISU
   class GaussPoints_i;
 }
 
+//! Specific Scalar Bar tab.
+/*! Uses for set up Gauss Points Scalar Bars preferenses. */
 class VisuGUI_GaussScalarBarPane : public QVBox
 {
   Q_OBJECT
@@ -116,15 +118,23 @@ class VisuGUI_GaussScalarBarPane : public QVBox
   void onTextPref();
 };
 
+//! Create Gauss Points Presentation Dialog.
+/*!
+ * Uses for set up initial parameters of the Gauss Points
+ * presentation and edit them interactively.
+ */
 class VisuGUI_GaussPointsDlg : public QDialog
 {
-    Q_OBJECT
+  Q_OBJECT
 
 public:
-    VisuGUI_GaussPointsDlg (SalomeApp_Module* theModule, bool SetPref = FALSE);
-    ~VisuGUI_GaussPointsDlg() {};
+  VisuGUI_GaussPointsDlg (SalomeApp_Module* theModule, bool SetPref = FALSE);
+  ~VisuGUI_GaussPointsDlg() {};
 
+  //! Initializing dialog from the Gauss Points presentation.
   void    initFromPrsObject(VISU::GaussPoints_i* thePrs);
+
+  //! Update Gauss Points presentation using parameters from the dialog.
   int     storeToPrsObject(VISU::GaussPoints_i* thePrs);
 
 protected slots:
diff --git a/src/VISUGUI/VisuGUI_Module.h b/src/VISUGUI/VisuGUI_Module.h
index 33a1ec02..8531e958 100644
--- a/src/VISUGUI/VisuGUI_Module.h
+++ b/src/VISUGUI/VisuGUI_Module.h
@@ -46,7 +46,8 @@ namespace VISU
   typedef std::map<SUIT_ViewManager*,PViewer> TViewerMap;
 }
 
-
+//! This class inherits base VisuGUI.
+/*! Used to display, erase end edit presentations in the VVTK viewer. */
 class VisuGUI_Module: public VisuGUI
 {
   Q_OBJECT;
@@ -59,10 +60,12 @@ public:
   virtual
   ~VisuGUI_Module();
 
+  //! Redifined method of the module initializing.
   virtual
   void
   initialize( CAM_Application* );
 
+  //! Redefined method of creating prefernces.
   virtual 
   void 
   createPreferences();
@@ -77,31 +80,38 @@ public:
 		 const bool theIsCreate);
 
 public slots:
+  //! Reimplemented method of the module deactivation.
   virtual 
   bool
   deactivateModule( SUIT_Study* );
 
+  //! Reimplemented method of the module activation.
   virtual 
   bool
   activateModule( SUIT_Study* );
 
 protected:
+  //! Create preferences for Gauss Points presentation.
   virtual 
   void 
   createGaussPointsPreferences();
 
+  //! Create preferences for Gauss Points Scalar Bars.
   virtual 
   void 
   createScalarBarPreferences();
 
+  //! Create preferences for Outside Cursor Gauss Points presentations.
   virtual 
   void 
   createOutsideCursorPreferences();
 
+  //! Create preferences for Picking.
   virtual 
   void 
   createPickingPreferences();
 
+  //! Create preferences for Space Mouse.
   virtual 
   void 
   createSpaceMousePreferences();
@@ -122,30 +132,37 @@ protected slots:
   void 
   OnViewManagerAdded(SUIT_ViewManager*);
 
+  //! Reimplemented method of the Gauss Points edition.
   virtual
   void
   OnEditGaussPoints();
 
+  //! Reimplemented method of the Gauss Points displaying.
   virtual 
   void
   OnDisplayPrs();
 
+  //! Reimplemented method of the Gauss Points displaying only.
   virtual 
   void
   OnDisplayOnlyPrs();
 
+  //! Reimplemented method of the Gauss Points full erasing.
   virtual
   void
   OnEraseAll();
 
+  //! Reimplemented method of the Gauss Points erasing.
   virtual
   void
   OnErasePrs();
 
+  //! Reimplemented method of saving view parameters.
   virtual
   void
   OnSaveViewParams();
 
+  //! Reimplemented method of restoring view parameters.
   virtual
   void
   OnRestoreViewParams();