Merge pull request #4997 from monishdeb/CRM-15536

[civicrm-core.git] / CRM / Core / Lock.php

diff --git a/CRM/Core/Lock.php b/CRM/Core/Lock.php
index 73c16cde9f33c9aa146f36f6bf965e8b48cb1c8a..215d39490a7f0b4203d99c8f031c01756c9d78ae 100644 (file)
--- a/CRM/Core/Lock.php
+++ b/CRM/Core/Lock.php
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -44,10 +44,13 @@ class CRM_Core_Lock {
   /**
    * Initialize the constants used during lock acquire / release
    *
-   * @param string $name name of the lock. Please prefix with component / functionality
+   * @param string $name
+   *   Name of the lock. Please prefix with component / functionality.
    *                      e.g. civimail.cronjob.JOB_ID
-   * @param int $timeout the number of seconds to wait to get the lock. 1 if not set
-   * @param boolean $serverWideLock should this lock be applicable across your entire mysql server
+   * @param int $timeout
+   *   The number of seconds to wait to get the lock. 1 if not set.
+   * @param bool $serverWideLock
+   *   Should this lock be applicable across your entire mysql server.
    *                                this is useful if you have multiple sites running on the same
    *                                mysql server and you want to limit the number of parallel cron
    *                                jobs - CRM-91XX
@@ -145,7 +148,7 @@ class CRM_Core_Lock {
    *
    * @param string $jobLog
    * @throws CRM_Core_Exception
-   * @return boolean
+   * @return bool
    */
   public function hackyHandleBrokenCode($jobLog) {
     if (stristr($this->_name, 'job')) {
@@ -157,5 +160,5 @@ class CRM_Core_Lock {
     $this->_hasLock = TRUE;
     return TRUE;
   }
-}
 
+}