sbergmann Fri Jul 13 02:40:03 2001 EDT
Added files:
/phpdoc/en/pear benchmark_timer.xml
Log:
Check-in of, yet uncomplete, PEAR/Benchmark_Timer class documentation.
Index: phpdoc/en/pear/benchmark_timer.xml
+++ phpdoc/en/pear/benchmark_timer.xml
<refentry id="class.benchmark-timer">
<refnamediv>
<refname>Benchmark_Timer</refname>
<refpurpose>Timing script execution</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>...</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<simpara>
...
</simpara>
</refsect1>
<refsect1>
<example id="example.pear.benchmark.timer">
<programlisting role="php">
require_one 'Benchmark/Timer.php';
$timer = new Benchmark_Timer;
$timer->setMarker('start of for() loop');
for ($i = 0; $i < 1000; $i++) { /* ... */ }
$timer->setMarker('end of for() loop');
echo 'The for() loop took ' .
$timer->timeElapsed('start of for() loop', 'end of for() loop');
</programlisting>
</example>
</refsect1>
</refentry>
<refentry id="function.benchmark-timer.start">
<refnamediv>
<refname>start</refname>
<refpurpose>Set a default marker, called 'start'.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>...</synopsis>
</refsynopsisdiv>
</refentry>
<refentry id="function.benchmark-timer.stop">
<refnamediv>
<refname>stop</refname>
<refpurpose>Set a default marker, called 'stop'.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>...</synopsis>
</refsynopsisdiv>
</refentry>
