From 134afe36e2c9734ccc6ed6be5a1896c41dc52227 Mon Sep 17 00:00:00 2001
From: Andreas Fischer <bantu@phpbb.com>
Date: Thu, 16 Dec 2010 03:14:41 +0100
Subject: [PATCH] [feature/system-cron] Add phpDoc documentation for
 phpbb_cron_lock class.

PHPBB3-9596
---
 phpBB/includes/cron/lock.php | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/phpBB/includes/cron/lock.php b/phpBB/includes/cron/lock.php
index b407191922..b2ba89ad6c 100644
--- a/phpBB/includes/cron/lock.php
+++ b/phpBB/includes/cron/lock.php
@@ -21,8 +21,20 @@ if (!defined('IN_PHPBB'))
 */
 class phpbb_cron_lock
 {
+	/**
+	* Unique identifier for this lock.
+	*
+	* @var string
+	*/
 	private $cron_id;
 
+	/**
+	* Tries to acquire the cron lock by updating 
+	* the 'cron_lock' configuration variable in the database.
+	*
+	* @return bool		true if lock was acquired
+	*					false otherwise
+	*/
 	public function lock()
 	{
 		global $config, $db;
@@ -67,6 +79,8 @@ class phpbb_cron_lock
 	* Releases cron lock.
 	*
 	* Attempting to release a cron lock that is already released is harmless.
+	*
+	* @return void
 	*/
 	public function unlock()
 	{