update

[rrq/rrqforth.git] / adoc / p_clear_stream.adoc

diff --git a/adoc/p_clear_stream.adoc b/adoc/p_clear_stream.adoc
index 7672daf7150616850265b0ac17389d7c6470446b..5ecd9fad993e28e1939a5b912887e1b80a347519 100644 (file)
--- a/adoc/p_clear_stream.adoc
+++ b/adoc/p_clear_stream.adoc
@@ -1,9 +1,15 @@
+// stdio.asm:  WORD p_clear_stream,'CLEAR-STREAM',fasm
+
 anchor:p_clear_stream[]
 
-Word: CLEAR-STREAM
-------------------
+=== Word: CLEAR-STREAM
+
+....
+Data stack: ( stream -- )
+....
 
-----
-stdio.asm:     WORD p_clear_stream,'CLEAR-STREAM',fasm
-----
+"CLEAR-STREAM" is a function word that discards whatever is currently
+remaining in the buffer for the stream, so that a subsequent read will
+pull in more data from its source.
 
+See also <<p_read_stream_char,READ-STREAM-CHAR>>.