nlopess Tue Sep 21 11:47:51 2004 EDT
Modified files:
/phpdoc/en/reference/math/functions hypot.xml
Log:
add documentation
http://cvs.php.net/diff.php/phpdoc/en/reference/math/functions/hypot.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/math/functions/hypot.xml
diff -u phpdoc/en/reference/math/functions/hypot.xml:1.4
phpdoc/en/reference/math/functions/hypot.xml:1.5
--- phpdoc/en/reference/math/functions/hypot.xml:1.4 Fri Jun 11 04:28:50 2004
+++ phpdoc/en/reference/math/functions/hypot.xml Tue Sep 21 11:47:51 2004
@@ -1,22 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/math.xml, last change in rev 1.72 -->
<refentry id='function.hypot'>
<refnamediv>
<refname>hypot</refname>
<refpurpose>
- Returns sqrt(num1*num1 + num2*num2)
+ Calculate the length of the hypotenuse of a right-angle triangle
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
- <methodsynopsis>
- <type>float</type><methodname>hypot</methodname>
- <methodparam><type>float</type><parameter>num1</parameter></methodparam>
- <methodparam><type>float</type><parameter>num2</parameter></methodparam>
- </methodsynopsis>
+ <methodsynopsis>
+ <type>float</type><methodname>hypot</methodname>
+ <methodparam><type>float</type><parameter>x</parameter></methodparam>
+ <methodparam><type>float</type><parameter>y</parameter></methodparam>
+ </methodsynopsis>
<para>
- &warn.undocumented.func;
+ <function>hypot</function> returns the length of the hypotenuse of a
+ right-angle triangle with sides of length <parameter>x</parameter> and
+ <parameter>y</parameter>, or the distance of the point
+ (<parameter>x</parameter>, <parameter>y</parameter>) from the origin.
+ This is equivalent to <literal>sqrt(x*x + y*y)</literal>.
</para>
</refsect1>
</refentry>
