From: apo <apo@opencascade.com>
Date: Tue, 25 Oct 2005 08:26:54 +0000 (+0000)
Subject: Documentation of the sources
X-Git-Tag: TG-D5-38-2003_D2005-29-12~46
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=58aa0ad497cac4ff46844fe6093b896404cbbce7;p=modules%2Fgui.git

Documentation of the sources
---

diff --git a/src/SVTK/SVTK_RenderWindowInteractor.h b/src/SVTK/SVTK_RenderWindowInteractor.h
index d0cb21cbf..4d7e6ca95 100644
--- a/src/SVTK/SVTK_RenderWindowInteractor.h
+++ b/src/SVTK/SVTK_RenderWindowInteractor.h
@@ -144,6 +144,7 @@ class SVTK_EXPORT SVTK_RenderWindowInteractor: public QVTK_RenderWindowInteracto
 
   ~SVTK_RenderWindowInteractor();
 
+  //! To initialize properly the class
   virtual
   void
   Initialize(vtkGenericRenderWindowInteractor* theDevice,
@@ -151,33 +152,42 @@ class SVTK_EXPORT SVTK_RenderWindowInteractor: public QVTK_RenderWindowInteracto
 	     SVTK_Selector* theSelector);
 
   //----------------------------------------------------------------------------
+  //! To get corresponding SVTK_Renderer instance
   SVTK_Renderer* 
   GetRenderer();
 
+  //! To get corresponding SVTK_Renderer device (just to simplify collobaration with SVTK_Renderer)
   vtkRenderer* 
   getRenderer();
 
   //----------------------------------------------------------------------------
+  //! To get current interactor style
   vtkInteractorStyle* 
   GetInteractorStyle();
 
+  //! To change current interactor style by pushing the new one into the container
   void
   PushInteractorStyle(vtkInteractorStyle* theStyle);
 
+  //! To restore previous interactor style
   void
   PopInteractorStyle();
 
   //----------------------------------------------------------------------------
+  //! To get corresponding SVTK_Selector
   SVTK_Selector* 
   GetSelector();
 
+  //! To get current selection mode (just to simplify collobaration with SVTK_Selector)
   Selection_Mode 
   SelectionMode() const;
 
+  //! To change selection mode (just to simplify collobaration with SVTK_Selector)
   void 
   SetSelectionMode(Selection_Mode theMode);
 
  public:
+  //! To transform vtkCommand::EndPickEvent to Qt selectionChanged signal
   void
   onEmitSelectionChanged();