0023299: [CEA] Finalize multi-study removal

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

diff --git a/idl/Logger.idl b/idl/Logger.idl
index e69d5f2dd1ebe503aab60dd787dfc908bd1319c2..f31d4a21ac79462cd74c28f1c11668bb8ec3493d 100644 (file)
--- a/idl/Logger.idl
+++ b/idl/Logger.idl
@@ -1,24 +1,25 @@
-//  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2016  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
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
 //
-//  This library is free software; you can redistribute it and/or
-//  modify it under the terms of the GNU Lesser General Public
-//  License as published by the Free Software Foundation; either
-//  version 2.1 of the License.
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
 //
-//  This library is distributed in the hope that it will be useful,
-//  but WITHOUT ANY WARRANTY; without even the implied warranty of
-//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-//  Lesser General Public License for more details.
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
 //
-//  You should have received a copy of the GNU Lesser General Public
-//  License along with this library; if not, write to the Free Software
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-//  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+// 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();
          };
 };