Annajwaszahro
/
MIF_E31222691
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve internal documentation of benchmark class.

This commit is contained in:
Taylor Otwell 2011-08-09 15:33:31 -05:00
parent 9f7cd6007b
commit 3ba3089208
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
system/benchmark.php
View File

@ -3,7 +3,7 @@
class Benchmark { class Benchmark {
/** /**
* Benchmark starting times. * All of the benchmark starting times.
* *
* @var array * @var array
*/ */
@ -12,8 +12,16 @@ class Benchmark {
/** /**
* Start a benchmark. * Start a benchmark.
* *
* After starting a benchmark, the elapsed time in milliseconds can be
* retrieved using the "check" method.
*
* <code>
* Benchmark::start('name');
* </code>
*
* @param string $name * @param string $name
* @return void * @return void
* @see check
*/ */
public static function start($name) public static function start($name)
{ {
@ -23,8 +31,13 @@ public static function start($name)
/** /**
* Get the elapsed time in milliseconds since starting a benchmark. * Get the elapsed time in milliseconds since starting a benchmark.
* *
* <code>
* echo Benchmark::check('name');
* </code>
*
* @param string $name * @param string $name
* @return float * @return float
* @see start
*/ */
public static function check($name) public static function check($name)
{ {