From a8f6660da71c0464102aa2286083350b9b52a436 Mon Sep 17 00:00:00 2001
From: Andrew McMillan <debian@mcmillan.net.nz>
Date: Wed, 6 Dec 2006 23:21:41 +1300
Subject: [PATCH] Improve comments.

---
 inc/CalDAVRequest.php | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/inc/CalDAVRequest.php b/inc/CalDAVRequest.php
index ae11158a..caca0a4b 100644
--- a/inc/CalDAVRequest.php
+++ b/inc/CalDAVRequest.php
@@ -280,11 +280,13 @@ class CalDAVRequest
 
 
   /**
-  * Returns the DB object associated with a lock token, or false.
+  * This will either (a) return false if no locks apply, or (b) return the lock_token
+  * which the request successfully included to open the lock, or:
+  * (c) respond directly to the client with the failure.
   *
-  * @param string $lock_token The opaquelocktoken which we are looking for
+  * @return mixed false (no lock) or opaquelocktoken (opened lock)
   */
-  function FailIfLocked( $lock_token ) {
+  function FailIfLocked() {
     if ( $existing_lock = $this->IsLocked() ) { // NOTE Assignment in if() is expected here.
       dbg_error_log( "caldav", "There is a lock on '%s'", $this->path);
       if ( ! $request->ValidateLockToken($existing_lock) ) {