class: Stream
authorClaus Gittinger <cg@exept.de>
Sat, 23 May 2015 15:09:26 +0200
changeset 18394 80d135c6aecb
parent 18393 466f978c53a8
child 18395 b9ba2c56b13b
class: Stream comment/format in:6 methods
Stream.st
--- a/Stream.st	Sat May 23 14:55:36 2015 +0200
+++ b/Stream.st	Sat May 23 15:09:26 2015 +0200
@@ -1965,10 +1965,20 @@
 !Stream methodsFor:'queries'!
 
 canReadWithoutBlocking
+    "return true, if the stream can be read without blocking the program (actually: suspending the thread).
+     This is redefined in external streams, which read from a communication line
+     (sockets and devices).
+     Always true here, because all internal streams never block"
+
     ^ true
 !
 
 canWriteWithoutBlocking
+    "return true, if the stream can be written without blocking the program (actually: suspending the thread).
+     This is redefined in external streams, which write to a communication line
+     (sockets and devices).
+     Always true here, because all internal streams never block"
+
     ^ true
 !
 
@@ -2936,10 +2946,14 @@
 !
 
 isEncodedStream
+    "true, iff this is an encoder/decoder stream"
+
     ^ false
 !
 
 isLineNumberReadStream
+    "true, iff this is a lineNumbering stream"
+
     ^ false
 !
 
@@ -2971,10 +2985,14 @@
 !
 
 isTerminalStream
+    "true, iff this is a terminal emulator stream"
+
     ^ false
 !
 
 isTextCollector
+    "true, iff this is a text collector emulating a stream"
+
     ^ false
 
     "
@@ -3788,11 +3806,11 @@
 !Stream class methodsFor:'documentation'!
 
 version
-    ^ '$Header: /cvs/stx/stx/libbasic/Stream.st,v 1.244 2015-05-23 12:55:36 cg Exp $'
+    ^ '$Header: /cvs/stx/stx/libbasic/Stream.st,v 1.245 2015-05-23 13:09:26 cg Exp $'
 !
 
 version_CVS
-    ^ '$Header: /cvs/stx/stx/libbasic/Stream.st,v 1.244 2015-05-23 12:55:36 cg Exp $'
+    ^ '$Header: /cvs/stx/stx/libbasic/Stream.st,v 1.245 2015-05-23 13:09:26 cg Exp $'
 ! !