added various function descriptions
authornjd- <njd->
Tue, 29 Jul 2003 06:51:15 +0000 (06:51 +0000)
committernjd- <njd->
Tue, 29 Jul 2003 06:51:15 +0000 (06:51 +0000)
net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/phpsyntax.xml

index 3824b20..175249e 100644 (file)
@@ -78,16 +78,16 @@ about the given resource and returns this information in a class.
         <phpsyntax function="assert_options"></phpsyntax>
         <phpsyntax function="atan"></phpsyntax>
         <phpsyntax function="atan2"></phpsyntax>
-        <phpsyntax function="base64_decode"></phpsyntax>
-        <phpsyntax function="base64_encode"></phpsyntax>
-        <phpsyntax function="base_convert"></phpsyntax>
-        <phpsyntax function="basename"></phpsyntax>
-        <phpsyntax function="bcadd"></phpsyntax>
-        <phpsyntax function="bccomp"></phpsyntax>
-        <phpsyntax function="bcdiv"></phpsyntax>
-        <phpsyntax function="bcmod"></phpsyntax>
-        <phpsyntax function="bcmul"></phpsyntax>
-        <phpsyntax function="bcpow"></phpsyntax>
+        <phpsyntax function="base64_decode" usage="string base64_decode ( string encoded_data)">base64_decode() decodes encoded_data and returns the original data. The returned data may be binary.</phpsyntax>
+        <phpsyntax function="base64_encode" usage="string base64_encode ( string data)">base64_encode returns data encoded with base64. This encoding is designed to make binary data survive transport through transport layers that are not 8-bit clean, such as mail bodies.</phpsyntax>
+        <phpsyntax function="base_convert" usage="string base_convert ( string number, int frombase, int tobase)">Returns a string containing number represented in base tobase. The base in which number is given is specified in frombase. Both frombase and tobase have to be between 2 and 36, inclusive. Digits in numbers with a base higher than 10 will be represented with the letters a-z, with a meaning 10, b meaning 11 and z meaning 35.</phpsyntax>
+        <phpsyntax function="basename" usage="string basename ( string path [, string suffix])">Given a string containing a path to a file, this function will return the base name of the file. If the filename ends in suffix this will also be cut off.</phpsyntax>
+        <phpsyntax function="bcadd" usage="string bcadd ( string left_operand, string right_operand [, int scale])">Adds the left_operand to the right_operand and returns the sum in a string. The optional scale parameter is used to set the number of digits after the decimal place in the result.</phpsyntax>
+        <phpsyntax function="bccomp" usage="int bccomp ( string left_operand, string right_operand [, int scale])">Compares the left_operand to the right_operand and returns the result as an integer. The optional scale parameter is used to set the number of digits after the decimal place which will be used in the comparison. The return value is 0 if the two operands are equal. If the left_operand is larger than the right_operand the return value is +1 and if the left_operand is less than the right_operand the return value is -1.</phpsyntax>
+        <phpsyntax function="bcdiv" usage="string bcdiv ( string left_operand, string right_operand [, int scale])">Divides the left_operand by the right_operand and returns the result. The optional scale sets the number of digits after the decimal place in the result. </phpsyntax>
+        <phpsyntax function="bcmod" usage="string bcmod ( string left_operand, string modulus)">Get the modulus of the left_operand using modulus.</phpsyntax>
+        <phpsyntax function="bcmul" usage="string bcmul ( string left_operand, string right_operand [, int scale])">Multiply the left_operand by the right_operand and returns the result. The optional scale sets the number of digits after the decimal place in the result.</phpsyntax>
+        <phpsyntax function="bcpow" usage="string bcpow ( string x, int y [, int scale])">Raise x to the power y. The optional scale can be used to set the number of digits after the decimal place in the result.</phpsyntax>
         <phpsyntax function="bcscale"></phpsyntax>
         <phpsyntax function="bcsqrt"></phpsyntax>
         <phpsyntax function="bcsub"></phpsyntax>