From 3ba3089208dece7255c88b0c4272d62d5a5dad96 Mon Sep 17 00:00:00 2001
From: Taylor Otwell <taylorotwell@gmail.com>
Date: Tue, 9 Aug 2011 15:33:31 -0500
Subject: [PATCH] Improve internal documentation of benchmark class.

---
 system/benchmark.php | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/system/benchmark.php b/system/benchmark.php
index c0d71eb2..bf353e6a 100644
--- a/system/benchmark.php
+++ b/system/benchmark.php
@@ -3,7 +3,7 @@
 class Benchmark {
 
 	/**
-	 * Benchmark starting times.
+	 * All of the benchmark starting times.
 	 *
 	 * @var array
 	 */
@@ -12,8 +12,16 @@ class 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
 	 * @return void
+	 * @see    check
 	 */
 	public static function start($name)
 	{
@@ -23,8 +31,13 @@ public static function start($name)
 	/**
 	 * Get the elapsed time in milliseconds since starting a benchmark.
 	 *
+	 * <code>
+	 * echo Benchmark::check('name');
+	 * </code>
+	 *
 	 * @param  string  $name
 	 * @return float
+	 * @see    start
 	 */
 	public static function check($name)
 	{