Ignore:
Timestamp:
Apr 13, 2000, 5:58:41 PM (25 years ago)
Author:
ansari
Message:

Documentation + Modifs mineures (namespace, etc..) - Reza 13/4/2000

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SophyaLib/BaseTools/pexceptions.h

    r895 r913  
    1717  string BuildLongExceptionMessage(const char * s, const char *file, int line);
    1818
    19 //! Base exception class in Sophya.
    20 /*! Ancestor for PError and PException
     19/*! \ingroup SysTools
     20    \brief Base exception class in Sophya
     21
     22    Ancestor for PError and PException
    2123    It has a message, and an id to give more
    2224    information on the exception.
     
    4143//      PException
    4244 
    43 //! A PError is a serious logic error. Usually not caught...
     45/*! \ingroup SysTools
     46    \brief A PError is a serious logic error. Usually not caught... */
    4447  class PError : public PThrowable {
    4548  public:
     
    4750  };
    4851 
    49 //! A PException is not as serious... Can be caught.
     52/*! \ingroup SysTools
     53    \brief A PException is not as serious... Can be caught. */
    5054  class PException : public PThrowable {
    5155  public:
     
    6064//     AssertionFailedError
    6165
    62 //! Memory allocation failure
     66/*! \ingroup SysTools
     67    \brief Memory allocation failure */
    6368  class AllocationError : public PError {
    6469  public:
     
    6671  };
    6772 
    68 //! Null pointer error
     73/*! \ingroup SysTools
     74    \brief Null pointer error */
    6975  class NullPtrError : public PError {
    7076  public:
     
    7379 
    7480 
    75 //! Calling a forbidden method, trying a forbidden operation
     81/*! \ingroup SysTools
     82    \brief Calling a forbidden method, trying a forbidden operation */
    7683  class ForbiddenError : public PError {
    7784  public:
     
    8087
    8188 
    82 //! ASSERT macro failure. The message is the assertion...
     89/*! \ingroup SysTools
     90    \brief ASSERT macro failure. The message is the assertion... */
    8391  class AssertionFailedError : public PError {
    8492  public:
     
    101109  //   CaughtSignalExc
    102110 
    103   //! Generic IO Exception.
     111/*! \ingroup SysTools
     112    \brief Generic IO Exception */
    104113  class IOExc : public PException {
    105114  public:
     
    107116  };
    108117
    109   //! Bad file format.
     118/*! \ingroup SysTools
     119    \brief Bad file format */
    110120  class FileFormatExc : public IOExc {
    111121  public:
     
    113123  };
    114124
    115   //! Size mismatch between objects.
     125/*! \ingroup SysTools
     126    \brief Size mismatch between objects */
    116127  class SzMismatchError : public PException {
    117128  public:
     
    119130  };
    120131 
    121   //! Out of bounds for array, matrix, etc.
     132/*! \ingroup SysTools
     133    \brief Out of bounds for array, matrix, etc */
    122134  class RangeCheckError : public PException {
    123135  public:
     
    125137  };
    126138 
    127   //! Invalid parameter to method/constructor...
     139/*! \ingroup SysTools
     140    \brief Invalid parameter to method/constructor... */
    128141  class ParmError : public PException {
    129142  public:
     
    131144  };
    132145
    133   //! Calling a non available / not implemented method
     146/*! \ingroup SysTools
     147    \brief Calling a non available / not implemented method */
    134148  class NotAvailableOperation : public PException {
    135149  public:
     
    137151  };
    138152
    139   //! Bad data type -> keep ?
     153/*! \ingroup SysTools
     154    \brief Bad data type -> keep ? */
    140155  class TypeMismatchExc : public PException {
    141156  public:
     
    143158  };
    144159
    145   //! Math operation exception
     160/*! \ingroup SysTools
     161    \brief Math operation exception */
    146162  class MathExc : public PException {
    147163  public:
     
    149165  };
    150166 
    151   //! Singular matrix
     167/*! \ingroup SysTools
     168    \brief Singular matrix  */
    152169  class SingMatrixExc : public MathExc {
    153170  public:
     
    155172  };
    156173
    157   //! Duplicate identifier during registration
     174/*! \ingroup SysTools
     175    \brief Duplicate identifier during registration */
    158176  class DuplicateIdExc : public PException {
    159177  public:
     
    161179  };
    162180 
    163   //! Not found identifier
     181/*! \ingroup SysTools
     182    \brief Not found identifier  */
    164183  class NotFoundExc : public PException {
    165184  public:
     
    167186  };
    168187 
    169   //! Generated exception when processing a signal
     188/*! \ingroup SysTools
     189    \brief Generated exception when processing a signal */
    170190  class CaughtSignalExc : public PException {
    171191  public:
Note: See TracChangeset for help on using the changeset viewer.