add documentation
authorStefan Vogel <sv@exept.de>
Wed, 16 Nov 2005 09:44:41 +0100
changeset 8989 55e8738f8b57
parent 8988 2e82cf20dbbd
child 8990 b49b2dab68cd
add documentation
EndOfStreamNotification.st
--- a/EndOfStreamNotification.st	Mon Nov 14 14:49:44 2005 +0100
+++ b/EndOfStreamNotification.st	Wed Nov 16 09:44:41 2005 +0100
@@ -16,7 +16,7 @@
 	instanceVariableNames:''
 	classVariableNames:''
 	poolDictionaries:''
-	category:'Streams'
+	category:'Kernel-Exceptions-Errors'
 !
 
 !EndOfStreamNotification class methodsFor:'documentation'!
@@ -33,10 +33,30 @@
  other person.  No title to or ownership of the software is
  hereby transferred.
 "
+!
+
+documentation
+"
+    This notification is raised on attempt to read after the end of a stream
+    has been reached. As a notification, it will be ignored if no handler exists.
+
+    It is raised, if Stream>>signalAtEnd:nil has been set (this is the default).
+
+    [author:]
+        Stefan Vogel (stefan@zwerg)
+
+    [instance variables:]
+
+    [class variables:]
+
+    [see also:]
+        EndOfStreamError
+
+"
 ! !
 
 !EndOfStreamNotification class methodsFor:'documentation'!
 
 version
-    ^ '$Header: /cvs/stx/stx/libbasic/EndOfStreamNotification.st,v 1.2 2003-08-29 19:32:37 cg Exp $'
+    ^ '$Header: /cvs/stx/stx/libbasic/EndOfStreamNotification.st,v 1.3 2005-11-16 08:44:41 stefan Exp $'
 ! !