This commit was generated by cvs2git to create tag 'V1_4_0b1'.

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

diff --git a/idl/SALOME_Exception.idl b/idl/SALOME_Exception.idl
index 6c559445b4fa1b8f375f05f260074a6184d37718..fd6a224c4a01dec3526638e87d3de1d6fab18a4d 100644 (file)
--- a/idl/SALOME_Exception.idl
+++ b/idl/SALOME_Exception.idl
@@ -24,25 +24,31 @@
 //  $Header$
 
 /*! \file SALOME_Exception.idl This file contains the objects defining the main exception used
-in %SALOME application.
+in %SALOME application. The idl SALOME_Exception provides a generic CORBA exception for SALOME,
+ with an attribute that gives an exception type,a message, plus optional source file name and line number. 
+This idl is intended to serve for all user CORBA exceptions raised in SALOME code, as IDL specification 
+does not support exception inheritance. So, all the user CORBA exceptions from SALOME could be 
+handled in a single catch. 
+
 */ 
 #ifndef _SALOME_EXCEPTION_IDL_
 #define _SALOME_EXCEPTION_IDL_
 
 /*! 
-Module SALOME regroups all idl definitions for SALOME Kernel
+Module %SALOME regroups all idl definitions for %SALOME Kernel component
 */ 
 
 module SALOME
 {
 /*! 
-This enumeration contains the elements indicating the type of the exception.
+This enumeration contains the elements indicating the type of the exception 
+which can be raised during %SALOME session.
 */  
   enum ExceptionType
     { 
       COMM,             /*!< Communication problem */
       BAD_PARAM,        /*!< Bad User parameters */
-      INTERNAL_ERROR    /*!< SALOME Bug, irrecoverable */ 
+      INTERNAL_ERROR    /*!< Application level problem, irrecoverable */ 
     };
 /*! 
 This struct contains a set of fields defining the structure of the exception.
@@ -59,7 +65,7 @@ The main exception in %SALOME application.
 */
   exception SALOME_Exception
   {
-    ExceptionStruct details;
+    ExceptionStruct details; /*!<Structure of the exception.*/
   };
 
 };