From 6385181b76f41e4441ba9b7fcf4c886cc435c7ff Mon Sep 17 00:00:00 2001
From: Marcus Boerger <helly@php.net>
Date: Tue, 27 May 2003 18:56:20 +0000
Subject: [PATCH] Update and Synch.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@128939 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../outcontrol/functions/ob-end-clean.xml     | 16 +++++--
 .../outcontrol/functions/ob-end-flush.xml     | 46 +++++++++++++++----
 2 files changed, 48 insertions(+), 14 deletions(-)

diff --git a/reference/outcontrol/functions/ob-end-clean.xml b/reference/outcontrol/functions/ob-end-clean.xml
index e0ecea67e8..0a19868cea 100644
--- a/reference/outcontrol/functions/ob-end-clean.xml
+++ b/reference/outcontrol/functions/ob-end-clean.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 <!-- splitted from ./en/functions/outcontrol.xml, last change in rev 1.1 -->
   <refentry id="function.ob-end-clean">
    <refnamediv>
@@ -16,8 +16,13 @@
      </methodsynopsis>
     <para>
      This function discards the contents of the topmost output buffer and
-     turns off this output buffering. It returns true when it successfully 
-     discarded one buffer and false otherwide. Reasons for failure are first
+     turns off this output buffering. If you want to further
+     process the buffer's contents you have to call
+     <function>ob_get_contents</function> before
+     <function>ob_end_clean</function> as the buffer contents are
+     discarded when <function>ob_end_flush</function> is called.
+     The function returns &true; when it successfully 
+     discarded one buffer and &false; otherwide. Reasons for failure are first
      that you called the function without an active buffer or that for some
      reason a buffer could not be deleted (possible for special buffer).
     </para>
@@ -44,8 +49,9 @@ while (@ob_end_clean());
       </simpara>
       <simpara>
        See also <function>ob_start</function>,
-       <function>ob_clean</function> and
-       <function>ob_end_flush</function>.
+       <function>ob_get_contents</function>,
+       <function>ob_flush</function> and
+       <function>ob_end_clean</function>.
       </simpara>
      </note>
     </para>
diff --git a/reference/outcontrol/functions/ob-end-flush.xml b/reference/outcontrol/functions/ob-end-flush.xml
index 757ae0dec8..efd6d32c9f 100644
--- a/reference/outcontrol/functions/ob-end-flush.xml
+++ b/reference/outcontrol/functions/ob-end-flush.xml
@@ -1,32 +1,60 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/outcontrol.xml, last change in rev 1.1 -->
   <refentry id="function.ob-end-flush">
    <refnamediv>
     <refname>ob_end_flush</refname> 
     <refpurpose>
-     Flush (send) the output buffer and turn off output buffering    
+     Flush (send) the output buffer and turn off output buffering
     </refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>void</type><methodname>ob_end_flush</methodname>
+      <type>bool </type><methodname>ob_end_flush</methodname>
       <void/>
      </methodsynopsis>
     <para>
-     This function will send the contents of the output buffer (if
-     any) and turn output buffering off.  If you want to further
+     This function will send the contents of the topmost output buffer (if
+     any) and turn this output buffer off.  If you want to further
      process the buffer's contents you have to call
      <function>ob_get_contents</function> before
      <function>ob_end_flush</function> as the buffer contents are
      discarded after <function>ob_end_flush</function> is called.
+     The function returns &true; when it successfully 
+     discarded one buffer and &false; otherwide. Reasons for failure are first
+     that you called the function without an active buffer or that for some
+     reason a buffer could not be deleted (possible for special buffer).
     </para>
     <para>
-     See also <function>ob_start</function>,
-     <function>ob_get_contents</function>,
-     <function>ob_flush</function> and
-     <function>ob_end_clean</function>.
+     The following example shows an easy way to flush and end all output 
+     buffers:
+     <example>
+      <title><function>ob_end_flush</function> example</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+while (@ob_end_flush());
+?>
+]]>
+      </programlisting>
+     </example>
+    </para>
+    <para>
+     <note>
+      <simpara>
+       If the function fails it generates an E_NOTICE.
+      </simpara>
+      <simpara>
+       The boolean return value was added in PHP 4.2.0.
+      </simpara>
+      <simpara>
+       See also <function>ob_start</function>,
+       <function>ob_get_contents</function>,
+       <function>ob_flush</function> and
+       <function>ob_end_clean</function>.
+      </simpara>
+     </note>
     </para>
    </refsect1>
   </refentry>