add new docs for memory_get_peak_usage()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@214306 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Nuno Lopes 2006-06-06 11:31:44 +00:00
parent 4b59e8d1bc
commit 7d647f243c
2 changed files with 58 additions and 2 deletions

View file

@ -0,0 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.memory-get-peak-usage">
<refnamediv>
<refname>memory_get_peak_usage</refname>
<refpurpose>Returns the peak of memory allocated by PHP</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>memory_get_peak_usage</methodname>
<void />
</methodsynopsis>
<para>
Returns the peak of memory, in bytes, that's been allocated to your PHP
script.
</para>
<para>
<function>memory_get_usage</function> will only be defined if your PHP
is compiled with the <literal>--enable-memory-limit</literal>
configuration option.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>memory_get_usage</function></member>
<member><link linkend="ini.memory-limit">memory_limit</link></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.memory-get-usage">
<refnamediv>
<refname>memory_get_usage</refname>
@ -45,7 +45,7 @@ echo memory_get_usage() . "\n"; // 36744
</example>
</para>
<para>
See also
See also <function>memory_get_peak_usage</function> and
<link linkend="ini.memory-limit">memory_limit</link>.
</para>
</refsect1>