didou Tue Aug 10 19:40:27 2004 EDT
Modified files:
/phpdoc/en/reference/bc/functions bcadd.xml bccomp.xml bcdiv.xml
bcmod.xml bcmul.xml bcpow.xml
bcpowmod.xml bcscale.xml
bcsqrt.xml bcsub.xml
Log:
Switched bcmath to the new doc style
# also moved a note before the example and removed unneeded screen tags
http://cvs.php.net/diff.php/phpdoc/en/reference/bc/functions/bcadd.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/bc/functions/bcadd.xml
diff -u phpdoc/en/reference/bc/functions/bcadd.xml:1.3
phpdoc/en/reference/bc/functions/bcadd.xml:1.4
--- phpdoc/en/reference/bc/functions/bcadd.xml:1.3 Tue Sep 16 21:33:22 2003
+++ phpdoc/en/reference/bc/functions/bcadd.xml Tue Aug 10 19:40:27 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 -->
<refentry id="function.bcadd">
<refnamediv>
@@ -21,10 +21,12 @@
used to set the number of digits after the decimal place in the
result.
</para>
- <para>
- <example>
- <title><function>bcadd</function> example</title>
- <programlisting role="php">
+ </refsect1>
+ <refsect1>
+ &reftitle.examples;
+ <example>
+ <title><function>bcadd</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -36,11 +38,13 @@
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
+ </refsect1>
+ <refsect1>
+ &reftitle.seealso;
<para>
- See also <function>bcsub</function>.
+ <function>bcsub</function>.
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/bc/functions/bccomp.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/bc/functions/bccomp.xml
diff -u phpdoc/en/reference/bc/functions/bccomp.xml:1.3
phpdoc/en/reference/bc/functions/bccomp.xml:1.4
--- phpdoc/en/reference/bc/functions/bccomp.xml:1.3 Thu Dec 18 05:02:11 2003
+++ phpdoc/en/reference/bc/functions/bccomp.xml Tue Aug 10 19:40:27 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 -->
<refentry id="function.bccomp">
<refnamediv>
@@ -26,31 +26,23 @@
is less than the <parameter>right_operand</parameter> the return
value is -1.
</para>
- <para>
- <example>
- <title><function>bccomp</function> example</title>
- <programlisting role="php">
+ </refsect1>
+ <refsect1>
+ &reftitle.examples;
+ <example>
+ <title><function>bccomp</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
-echo bccomp('1', '2') . "\n";
-echo bccomp('1.00001', '1', 3) . "\n";
-echo bccomp('1.00001', '1', 5);
+echo bccomp('1', '2') . "\n"; // -1
+echo bccomp('1.00001', '1', 3); // 0
+echo bccomp('1.00001', '1', 5); // 1
+
?>
]]>
- </programlisting>
- <para>
- The above example will output:
- </para>
- <screen>
-<![CDATA[
--1
-0
-1
-]]>
- </screen>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/bc/functions/bcdiv.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/bc/functions/bcdiv.xml
diff -u phpdoc/en/reference/bc/functions/bcdiv.xml:1.3
phpdoc/en/reference/bc/functions/bcdiv.xml:1.4
--- phpdoc/en/reference/bc/functions/bcdiv.xml:1.3 Tue Dec 16 07:48:28 2003
+++ phpdoc/en/reference/bc/functions/bcdiv.xml Tue Aug 10 19:40:27 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 -->
<refentry id="function.bcdiv">
<refnamediv>
@@ -20,10 +20,12 @@
optional <parameter>scale</parameter> sets the number of digits
after the decimal place in the result.
</para>
- <para>
- <example>
- <title><function>bcdiv</function> example</title>
- <programlisting role="php">
+ </refsect1>
+ <refsect1>
+ &reftitle.examples;
+ <example>
+ <title><function>bcdiv</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -31,11 +33,13 @@
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
+ </refsect1>
+ <refsect1>
+ &reftitle.seealso;
<para>
- See also <function>bcmul</function>.
+ <function>bcmul</function>.
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/bc/functions/bcmod.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/bc/functions/bcmod.xml
diff -u phpdoc/en/reference/bc/functions/bcmod.xml:1.3
phpdoc/en/reference/bc/functions/bcmod.xml:1.4
--- phpdoc/en/reference/bc/functions/bcmod.xml:1.3 Thu Dec 18 05:02:11 2003
+++ phpdoc/en/reference/bc/functions/bcmod.xml Tue Aug 10 19:40:27 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 -->
<refentry id="function.bcmod">
<refnamediv>
@@ -19,30 +19,25 @@
Get the modulus of the <parameter>left_operand</parameter> using
<parameter>modulus</parameter>.
</para>
- <para>
- <example>
- <title><function>bcmod</function> example</title>
- <programlisting role="php">
+ </refsect1>
+ <refsect1>
+ &reftitle.examples;
+ <example>
+ <title><function>bcmod</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
-echo bcmod(4, 2) . "\n";
-echo bcmod(2, 4);
+echo bcmod(4, 2); // 0
+echo bcmod(2, 4); // 2
?>
]]>
- </programlisting>
- <para>
- The above example will output:
- </para>
- <screen>
-<![CDATA[
-0
-2
-]]>
- </screen>
- </example>
- </para>
+ </programlisting>
+ </example>
+ </refsect1>
+ <refsect1>
+ &reftitle.seealso;
<para>
- See also <function>bcdiv</function>.
+ <function>bcdiv</function>.
</para>
</refsect1>
</refentry>
@@ -66,4 +61,4 @@
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
--->
+-->
\ No newline at end of file
http://cvs.php.net/diff.php/phpdoc/en/reference/bc/functions/bcmul.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/bc/functions/bcmul.xml
diff -u phpdoc/en/reference/bc/functions/bcmul.xml:1.3
phpdoc/en/reference/bc/functions/bcmul.xml:1.4
--- phpdoc/en/reference/bc/functions/bcmul.xml:1.3 Thu Dec 18 05:02:11 2003
+++ phpdoc/en/reference/bc/functions/bcmul.xml Tue Aug 10 19:40:27 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 -->
<refentry id="function.bcmul">
<refnamediv>
@@ -20,30 +20,25 @@
optional <parameter>scale</parameter> sets the number of digits
after the decimal place in the result.
</para>
- <para>
- <example>
- <title><function>bcmul</function> example</title>
- <programlisting role="php">
+ </refsect1>
+ <refsect1>
+ &reftitle.examples;
+ <example>
+ <title><function>bcmul</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
-echo bcmul(1.34747474747, 35, 3) . "\n";
-echo bcmul(2, 4);
+echo bcmul(1.34747474747, 35, 3); // 47.162
+echo bcmul(2, 4); // 8
?>
]]>
- </programlisting>
- <para>
- The above example will output:
- </para>
- <screen>
-<![CDATA[
-47.162
-8
-]]>
- </screen>
- </example>
- </para>
+ </programlisting>
+ </example>
+ </refsect1>
+ <refsect1>
+ &reftitle.seealso;
<para>
- See also <function>bcdiv</function>.
+ <function>bcdiv</function>.
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/bc/functions/bcpow.xml?r1=1.7&r2=1.8&ty=u
Index: phpdoc/en/reference/bc/functions/bcpow.xml
diff -u phpdoc/en/reference/bc/functions/bcpow.xml:1.7
phpdoc/en/reference/bc/functions/bcpow.xml:1.8
--- phpdoc/en/reference/bc/functions/bcpow.xml:1.7 Sun Jan 4 14:49:02 2004
+++ phpdoc/en/reference/bc/functions/bcpow.xml Tue Aug 10 19:40:27 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 -->
<refentry id="function.bcpow">
<refnamediv>
@@ -22,10 +22,12 @@
<parameter>scale</parameter> can be used to set the number of
digits after the decimal place in the result.
</para>
- <para>
- <example>
- <title><function>bcpow</function> example</title>
- <programlisting role="php">
+ </refsect1>
+ <refsect1>
+ &reftitle.examples;
+ <example>
+ <title><function>bcpow</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -33,11 +35,13 @@
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
+ </refsect1>
+ <refsect1>
+ &reftitle.seealso;
<para>
- See also <function>bcpowmod</function>, and
+ <function>bcpowmod</function>&listendand;
<function>bcsqrt</function>.
</para>
</refsect1>
http://cvs.php.net/diff.php/phpdoc/en/reference/bc/functions/bcpowmod.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/bc/functions/bcpowmod.xml
diff -u phpdoc/en/reference/bc/functions/bcpowmod.xml:1.4
phpdoc/en/reference/bc/functions/bcpowmod.xml:1.5
--- phpdoc/en/reference/bc/functions/bcpowmod.xml:1.4 Mon Dec 15 11:47:05 2003
+++ phpdoc/en/reference/bc/functions/bcpowmod.xml Tue Aug 10 19:40:27 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.bcpowmod">
<refnamediv>
<refname>bcpowmod</refname>
@@ -16,13 +16,23 @@
<methodparam><type>string</type><parameter>modulus</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>scale</parameter></methodparam>
</methodsynopsis>
- <simpara>
+ <para>
Use the fast-exponentiation method to raise <parameter>x</parameter>
to the power <parameter>y</parameter> with respect to the modulus
<parameter>modulus</parameter>. The optional
<parameter>scale</parameter> can be used to set the number of
digits after the decimal place in the result.
- </simpara>
+ </para>
+ <note>
+ <para>
+ Because this method uses the modulus operation, non-natural numbers
+ may give unexpected results. A natural number is any positive
+ non-zero integer.
+ </para>
+ </note>
+ </refsect1>
+ <refsect1>
+ &reftitle.examples;
<para>
The following two statements are functionally identical. The
<function>bcpowmod</function> version however, executes in
@@ -42,17 +52,11 @@
</programlisting>
</informalexample>
</para>
+ </refsect1>
+ <refsect1>
+ &reftitle.seealso;
<para>
- <note>
- <simpara>
- Because this method uses the modulus operation, non-natural numbers
- may give unexpected results. A natural number is any positive
- non-zero integer.
- </simpara>
- </note>
- </para>
- <para>
- See also <function>bcpow</function>, and
+ <function>bcpow</function>&listendand;
<function>bcmod</function>.
</para>
</refsect1>
http://cvs.php.net/diff.php/phpdoc/en/reference/bc/functions/bcscale.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/bc/functions/bcscale.xml
diff -u phpdoc/en/reference/bc/functions/bcscale.xml:1.4
phpdoc/en/reference/bc/functions/bcscale.xml:1.5
--- phpdoc/en/reference/bc/functions/bcscale.xml:1.4 Sun Jan 4 14:49:03 2004
+++ phpdoc/en/reference/bc/functions/bcscale.xml Tue Aug 10 19:40:27 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 -->
<refentry id="function.bcscale">
<refnamediv>
@@ -19,7 +19,9 @@
bc math functions that do not explicitly specify a scale
parameter. &return.success;
</para>
- <para>
+ </refsect1>
+ <refsect1>
+ &reftitle.examples;
<example>
<title><function>bcscale</function> example</title>
<programlisting role="php">
http://cvs.php.net/diff.php/phpdoc/en/reference/bc/functions/bcsqrt.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/bc/functions/bcsqrt.xml
diff -u phpdoc/en/reference/bc/functions/bcsqrt.xml:1.3
phpdoc/en/reference/bc/functions/bcsqrt.xml:1.4
--- phpdoc/en/reference/bc/functions/bcsqrt.xml:1.3 Tue Dec 16 07:48:28 2003
+++ phpdoc/en/reference/bc/functions/bcsqrt.xml Tue Aug 10 19:40:27 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 -->
<refentry id="function.bcsqrt">
<refnamediv>
@@ -20,10 +20,12 @@
The optional <parameter>scale</parameter> parameter sets the
number of digits after the decimal place in the result.
</para>
- <para>
- <example>
- <title><function>bcsqrt</function> example</title>
- <programlisting role="php">
+ </refsect1>
+ <refsect1>
+ &reftitle.examples;
+ <example>
+ <title><function>bcsqrt</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -31,11 +33,13 @@
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
+ </refsect1>
+ <refsect1>
+ &reftitle.seealso;
<para>
- See also <function>bcpow</function>.
+ <function>bcpow</function>.
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/bc/functions/bcsub.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/bc/functions/bcsub.xml
diff -u phpdoc/en/reference/bc/functions/bcsub.xml:1.3
phpdoc/en/reference/bc/functions/bcsub.xml:1.4
--- phpdoc/en/reference/bc/functions/bcsub.xml:1.3 Tue Sep 16 21:33:23 2003
+++ phpdoc/en/reference/bc/functions/bcsub.xml Tue Aug 10 19:40:27 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/bc.xml, last change in rev 1.2 -->
<refentry id="function.bcsub">
<refnamediv>
@@ -23,10 +23,12 @@
used to set the number of digits after the decimal place in the
result.
</para>
- <para>
- <example>
- <title><function>bcsub</function> example</title>
- <programlisting role="php">
+ </refsect1>
+ <refsect1>
+ &reftitle.examples;
+ <example>
+ <title><function>bcsub</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -38,11 +40,13 @@
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
+ </refsect1>
+ <refsect1>
+ &reftitle.seealso;
<para>
- See also <function>bcadd</function>.
+ <function>bcadd</function>.
</para>
</refsect1>
</refentry>
