#23826 [NEW]: ob_end_clean() returns error notice when buffer is empty

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@128933 c90b9560-bf6c-de11-be94-00142212c4b1

reference/outcontrol/functions/ob-end-clean.xml

@@ -1,5 +1,5 @@
 <?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-clean">
    <refnamediv>
@@ -11,18 +11,44 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>void</type><methodname>ob_end_clean</methodname>
+      <type>bool</type><methodname>ob_end_clean</methodname>
       <void/>
      </methodsynopsis>
     <para>
-     This function discards the contents of the output buffer and
-     turns off output buffering.
+     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
+     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_clean</function> and
      <function>ob_end_flush</function>.
     </para>
+   <para>
+    The following example shows an easy way to get rid of all output buffers:
+     <example>
+      <title><function>ob_end_clean</function> example</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+while (@ob_end_clean());
+?>
+]]>
+      </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>
+     </note>
+    </para>
    </refsect1>
   </refentry>