clean warning message

[modules/kernel.git] / idl / Logger.idl

diff --git a/idl/Logger.idl b/idl/Logger.idl
index e69d5f2dd1ebe503aab60dd787dfc908bd1319c2..26d30c38a5a7595b9cf0656422f5d7099acefe01 100644 (file)
--- a/idl/Logger.idl
+++ b/idl/Logger.idl
@@ -1,4 +1,4 @@
-//  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
+//  Copyright (C) 2007-2010  CEA/DEN, EDF R&D, OPEN CASCADE
 //
 //  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
@@ -19,6 +19,7 @@
 //
 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
+
 //  File   : Logger.idl
 //  Author : Vasily Rusyaev
 //
@@ -26,14 +27,26 @@
 #define SALOME_LOGGER_IDL
 
 #pragma prefix "opencascade.com"
+/*! \file Logger.idl \brief interfaces for %SALOME logger
+*/
 
+/*! \brief module that provides interface to %SALOME logger
+*/
 module SALOME_Logger 
 {
+/*! \brief interface to use the %SALOME logger
+*/
        interface Logger 
          {
-           //put message into one special place for all servers using Logger
+    /*! \brief put message into one special place for all servers using %SALOME logger
+
+      \param message the message to send
+    */
            oneway void putMessage (in string message);
+           
+           //! check if the logger is running
             void ping (); 
+           //! shutdown the logger server
             void shutdown();
          };
 };