Salome HOME
Fix for bug 10438: Crash during Explode on Blocks operation (Global selection on...
[modules/gui.git] / src / SUIT / SUIT_PopupClient.cxx
index ddb7951398e90d722da71ec232228a0f8a286854..c9e532793a28a7e78954c495d2a0429d5aea29d6 100644 (file)
@@ -2,21 +2,21 @@
 
 #include <qevent.h>
 
-/*
-  Class: SUIT_PopupClient [public]
-  Descr: Base class for instances which creates popup menu on QContextMenuEvent
-*/
-
+/*! constructor. initialize mySignal.*/
 SUIT_PopupClient::SUIT_PopupClient()
 : mySignal( 0 )
 {
 }
 
+/*! destructor. delete mySignal*/
 SUIT_PopupClient::~SUIT_PopupClient()
 {
   delete mySignal;
 }
 
+/*!
+  Connect popup request.
+*/
 bool SUIT_PopupClient::connectPopupRequest( QObject* reciever, const char* slot )
 {
   if ( !reciever || !slot )
@@ -27,6 +27,9 @@ bool SUIT_PopupClient::connectPopupRequest( QObject* reciever, const char* slot
                            reciever, slot );
 }
 
+/*!
+  Disconnect popup request.
+*/
 bool SUIT_PopupClient::disconnectPopupRequest( QObject* reciever, const char* slot )
 {
   if ( !reciever || !slot || !mySignal )
@@ -35,25 +38,32 @@ bool SUIT_PopupClient::disconnectPopupRequest( QObject* reciever, const char* sl
                               reciever, slot );
 }
 
+/*!
+  Send signal on context menu request.
+*/
 void SUIT_PopupClient::contextMenuRequest( QContextMenuEvent* e )
 {
   if ( mySignal )
     mySignal->sendSignal( this, e );
 }
 
-/*
-  Class: SUIT_PopupClient::Signal [internal]
-  Descr: invoke signal which is connected to reciever in SUIT_PopupClient
-*/
+/*!
+ *  \class SUIT_PopupClient::Signal
* Descr: invoke signal which is connected to reciever in SUIT_PopupClient
+ */
 
+/*! constructor*/
 SUIT_PopupClient::Signal::Signal()
 : QObject( 0 )
 {
 }
 
+/*! destructor. do nothing*/
 SUIT_PopupClient::Signal::~Signal()
 {}
 
+/*! Send signal to \a client on context menu request \a e.
+ */
 void SUIT_PopupClient::Signal::sendSignal( SUIT_PopupClient* client, QContextMenuEvent* e )
 {
   emit contextMenuRequest( client, e );