svn commit: r230894 - /jakarta/commons/proper/betwixt/trunk/xdocs/guide/output.xml

[rd...@apache.org]

Author: rdonkin
Date: Mon Aug  8 14:08:04 2005
New Revision: 230894

URL: http://svn.apache.org/viewcvs?rev=230894&view=rev
Log:
Improved javadocs. Thanks to Kirill Grouchnikov for spotting the deficiencies.

Modified:
    jakarta/commons/proper/betwixt/trunk/xdocs/guide/output.xml

Modified: jakarta/commons/proper/betwixt/trunk/xdocs/guide/output.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/betwixt/trunk/xdocs/guide/output.xml?rev=230894&r1=230893&r2=230894&view=diff
==============================================================================
--- jakarta/commons/proper/betwixt/trunk/xdocs/guide/output.xml (original)
+++ jakarta/commons/proper/betwixt/trunk/xdocs/guide/output.xml Mon Aug  8 14:08:04 2005
@@ -36,8 +36,17 @@
         <p>
 <code>BeanWriter</code> pushes results to a textual stream. This can be used
 to efficiently push content through a socket or just to create a simple String.
-Note that only document fragments are created so you may need to append any
+        </p> 
+        <p>
+<strong>Note</strong> that only document fragments are created so you may need to append any
 prologs before writing the bean.
+    </p>
+        <p>
+<strong>Note:</strong> also that Betwixt leaves management of the streams and readers to the 
+user (respecting the maxim that the opener should close). When a fragment has been written, Betwixt will 
+not close the stream automatically. However, for convenience, <code>close()</code> and <code>flush</code> 
+methods have been provided in <code>BeanWriter</code> which will close or flush (respectively) the underlying 
+stream or reader.
     </p>
         <subsection name='Rendering Empty Tags'>
             <p>



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org