Browse Source

Add comments to ctkVTKObjectEventsObserver::removeConnection

Julien Finet 14 years ago
parent
commit
b73cd294ec
1 changed files with 3 additions and 1 deletions
  1. 3 1
      Libs/Visualization/VTK/Core/ctkVTKObjectEventsObserver.h

+ 3 - 1
Libs/Visualization/VTK/Core/ctkVTKObjectEventsObserver.h

@@ -88,7 +88,9 @@ public:
                        float priority = 0.0);
 
   ///
-  /// Remove a connection
+  /// Remove all the connections matching vtkobj, event, qtobj and slot using
+  /// wildcards or not.
+  /// Returns the number of connection removed.
   int removeConnection(vtkObject* vtk_obj, unsigned long vtk_event = vtkCommand::NoEvent,
                        const QObject* qt_obj = 0, const char* qt_slot = 0);