PARAVIS HTML docs

[modules/paravis.git] / src / PVGUI / PVGUI_ProcessModuleHelper.cxx

diff --git a/src/PVGUI/PVGUI_ProcessModuleHelper.cxx b/src/PVGUI/PVGUI_ProcessModuleHelper.cxx
index 7079c52a9c81447bda76531e38ae9c7c356a0564..642c46acfed130222723bbf5ae53dfa062a65872 100644 (file)
--- a/src/PVGUI/PVGUI_ProcessModuleHelper.cxx
+++ b/src/PVGUI/PVGUI_ProcessModuleHelper.cxx
@@ -51,6 +51,9 @@ void PVGUI_ProcessModuleHelper::PrintSelf(ostream& os, vtkIndent indent)
 }
 
 //-----------------------------------------------------------------------------
+/*!
+  \brief Used by ParaView testing capabilities, not usable in SALOME.
+ */
 bool PVGUI_ProcessModuleHelper::compareView(const QString& ReferenceImage,
   double Threshold, ostream& Output, const QString& TempDirectory)
 {
@@ -62,22 +65,35 @@ bool PVGUI_ProcessModuleHelper::compareView(const QString& ReferenceImage,
 }
 
 //-----------------------------------------------------------------------------
+/*! 
+  \brief Reimplemented to suppress default ParaView client behavior. Does nothing.
+*/
 void PVGUI_ProcessModuleHelper::showOutputWindow()
 {
   // Do nothing here
 }
 
 //-----------------------------------------------------------------------------
+/*! 
+  \brief Reimplemented to suppress default ParaView client behavior. Does nothing.
+*/
 void PVGUI_ProcessModuleHelper::showWindow()
 {
 }
 
 //-----------------------------------------------------------------------------
+/*! 
+  \brief Reimplemented to suppress default ParaView client behavior. Does nothing.
+*/
 void PVGUI_ProcessModuleHelper::hideWindow()
 {
 }
 
 //-----------------------------------------------------------------------------
+/*! 
+  \brief Calls the base implementation and redirects ParaView output to PVGUI_OutputWindowAdapter instance.
+  \sa PVGUI_OutputWindowAdapter
+*/
 int PVGUI_ProcessModuleHelper::InitializeApplication(int argc, char** argv)
 {
   if ( pqProcessModuleGUIHelper::InitializeApplication( argc, argv ) ){
@@ -89,17 +105,26 @@ int PVGUI_ProcessModuleHelper::InitializeApplication(int argc, char** argv)
 }
 
 //-----------------------------------------------------------------------------
+/*! 
+  \brief Reimplemented to suppress default ParaView client behavior and not to run Qt event loop. Does nothing.
+*/
 int PVGUI_ProcessModuleHelper::appExec()
 {
   return 0;
 }
 
+/*! 
+  \brief Reimplemented to suppress default ParaView client behavior and not to exit after the client initalization. Does nothing.
+*/
 //-----------------------------------------------------------------------------
 int PVGUI_ProcessModuleHelper::postAppExec()
 {
   return 0;
 }
 
+/*! 
+  \brief Reimplemented to suppress default ParaView client behavior. Does nothing.
+*/
 //-----------------------------------------------------------------------------
 QWidget* PVGUI_ProcessModuleHelper::CreateMainWindow()
 {
@@ -107,6 +132,9 @@ QWidget* PVGUI_ProcessModuleHelper::CreateMainWindow()
 }
 
 //-----------------------------------------------------------------------------
+/*! 
+  \brief Reimplemented to suppress default ParaView client behavior. Does nothing.
+*/
 void PVGUI_ProcessModuleHelper::ExitApplication()
 {
   // Cannot exit here, so do nothing