Documenting new optional base parameter; patch submitted by Pollita.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@103305 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2002-11-11 07:29:48 +00:00
parent 9aa989779f
commit 341b61b860

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/math.xml, last change in rev 1.2 -->
<refentry id="function.log">
<refnamediv>
@ -11,10 +11,20 @@
<methodsynopsis>
<type>float</type><methodname>log</methodname>
<methodparam><type>float</type><parameter>arg</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>base</parameter></methodparam>
</methodsynopsis>
<para>
Returns the natural logarithm of <parameter>arg</parameter>.
If the optional <parameter>base</parameter> parameter is specified,
<function>log</function> returns log<subscript>base</subscript>
<parameter>arg</parameter>, otherwise <function>log</function>
returns the natural logarithm of <parameter>arg</parameter>.
</para>
<note>
<para>
The <parameter>base</parameter> parameter became available
with PHP verion 4.3.0
</para>
</note>
</refsect1>
</refentry>