]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/inputstr.tex
Added first batch of docs and notes for wxPython.
[wxWidgets.git] / docs / latex / wx / inputstr.tex
index fec1deea18a4960d742b6666be657c5337436167..ae346a3178ee91909064de5195d2ccc496c8772d 100644 (file)
@@ -7,6 +7,10 @@
 
 \helpref{wxStreamBase}{wxstreambase}
 
+\wxheading{Include files}
+
+<wx/stream.h>
+
 \wxheading{See also}
 
 \helpref{wxStreamBuffer}{wxstreambuffer}
@@ -52,7 +56,11 @@ Returns the first character in the input queue and removes it.
 
 Reads the specified amount of bytes and stores the data in \it{buffer}.
 
-\it{WARNING!} The buffer absolutely needs to have at least the specified size.
+\wxheading{Warning}
+
+The buffer absolutely needs to have at least the specified size.
+
+\wxheading{Return value}
 
 This function returns a reference on the current object, so the user can test
 any states of the stream right away.
@@ -62,6 +70,11 @@ any states of the stream right away.
 Reads data from the input queue and stores it in the specified output stream.
 The data is read until an error is raised by one of the two streams.
 
+\wxheading{Return value}
+
+This function returns a reference on the current object, so the user can test
+any states of the stream right away.
+
 % ------------------
 % Position functions
 % ------------------