Documentation
authorStefan Vogel <sv@exept.de>
Tue, 18 Feb 2003 14:45:38 +0100
changeset 7038 89e892bb8226
parent 7037 0771e159ad40
child 7039 6f1c02381145
Documentation
Exception.st
UserInformation.st
UserNotification.st
Warning.st
--- a/Exception.st	Tue Feb 18 14:40:13 2003 +0100
+++ b/Exception.st	Tue Feb 18 14:45:38 2003 +0100
@@ -37,14 +37,22 @@
 
 documentation
 "
-    all logic moved to GenericException,
-    to allow for some exceptions (UnhandledExceptionException and
-    Interrupts) not to be a child of Exception.
+    Exception is an abstract superclass of all exceptions in the system,
+    which are not generated by user actions (e.g. keyboard interrupts).
 
-    Exception is an abstract superclass of all exceptions in the system,
-    which are not generated by user actions (i.e. Interrupts).
+    Think twice before subclassing directly from Exception. Consider to subclass
+    from one of Exceptions subclasses Error, Warning, UserNotification...
+    Neither you handle Error instead of Exception, since breakpoints,
+    halts and user informational messages are processed as exceptions.
+
+    The behavior is in GenericException, to allow for some exceptions 
+    (UnhandledExceptionException and UserInterrupts) not to be a child of Exception.
 
     [see also:]
+        Error
+        Warning
+        UserNotification
+        Notifcation
         Signal
 "
 ! !
@@ -52,6 +60,6 @@
 !Exception class methodsFor:'documentation'!
 
 version
-    ^ '$Header: /cvs/stx/stx/libbasic/Exception.st,v 1.80 2001-11-17 10:01:02 cg Exp $'
+    ^ '$Header: /cvs/stx/stx/libbasic/Exception.st,v 1.81 2003-02-18 13:45:32 stefan Exp $'
 
 ! !
--- a/UserInformation.st	Tue Feb 18 14:40:13 2003 +0100
+++ b/UserInformation.st	Tue Feb 18 14:45:38 2003 +0100
@@ -13,7 +13,9 @@
 "    
     UserInformation is similar to UserNotification,
     but used for less important messages. 
-    It produces an info box with the message on the screen.
+    It produces an info box with the message on the screen. 
+    If no display is available, the message is written 
+    to the Transcript.
 
     [author:]
         Stefan Vogel
@@ -37,7 +39,7 @@
 !UserInformation class methodsFor:'documentation'!
 
 version
-    ^ '$Header: /cvs/stx/stx/libbasic/UserInformation.st,v 1.1 2003-02-17 19:37:05 stefan Exp $'
+    ^ '$Header: /cvs/stx/stx/libbasic/UserInformation.st,v 1.2 2003-02-18 13:45:34 stefan Exp $'
 ! !
 
 UserInformation initialize!
--- a/UserNotification.st	Tue Feb 18 14:40:13 2003 +0100
+++ b/UserNotification.st	Tue Feb 18 14:45:38 2003 +0100
@@ -39,9 +39,10 @@
 
 documentation
 "    
-    UserNotification is an abstract superclass of all user notification 
+    UserNotification is the superclass of all user notification 
     exceptions in the system. It produces an info box with the message
-    on the screen.
+    on the screen. If no display is available, the message is written 
+    to the Transcript.
 
     [author:]
         Stefan Vogel
@@ -118,7 +119,7 @@
 !UserNotification class methodsFor:'documentation'!
 
 version
-    ^ '$Header: /cvs/stx/stx/libbasic/UserNotification.st,v 1.5 2003-02-17 19:09:07 stefan Exp $'
+    ^ '$Header: /cvs/stx/stx/libbasic/UserNotification.st,v 1.6 2003-02-18 13:45:38 stefan Exp $'
 ! !
 
 UserNotification initialize!
--- a/Warning.st	Tue Feb 18 14:40:13 2003 +0100
+++ b/Warning.st	Tue Feb 18 14:45:38 2003 +0100
@@ -39,7 +39,10 @@
 
 documentation
 "
-    Warning is an abstract superclass of all warning exceptions in the system
+    Warning is the superclass of all warning exceptions in the system.
+    The default beavior for an unhandled Warning is to display a warn
+    box with the error decription. If no display is available, the error 
+    description is written to the Transcript.
 
     [author:]
         Stefan Vogel
@@ -47,7 +50,6 @@
     [see also:]
         Signal
 "
-
 !
 
 examples
@@ -153,7 +155,7 @@
 !Warning class methodsFor:'documentation'!
 
 version
-    ^ '$Header: /cvs/stx/stx/libbasic/Warning.st,v 1.9 2003-02-17 19:08:43 stefan Exp $'
+    ^ '$Header: /cvs/stx/stx/libbasic/Warning.st,v 1.10 2003-02-18 13:45:36 stefan Exp $'
 ! !
 
 Warning initialize!