comment fixes
[civicrm-core.git] / CRM / Queue / Queue.php
index 627c0c437b66441eb4638ac5a696bc839d445e7d..83a6b9af293f98b5fe63d75cede56185996c0a2e 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * A queue is an object (usually backed by some persistent data store)
@@ -60,7 +60,7 @@ abstract class CRM_Queue_Queue {
   }
 
   /**
-   * Determine the string name of this queue
+   * Determine the string name of this queue.
    *
    * @return string
    */
@@ -84,14 +84,14 @@ abstract class CRM_Queue_Queue {
   public abstract function deleteQueue();
 
   /**
-   * Check if the queue exists
+   * Check if the queue exists.
    *
    * @return bool
    */
   public abstract function existsQueue();
 
   /**
-   * Add a new item to the queue
+   * Add a new item to the queue.
    *
    * @param mixed $data
    *   Serializable PHP object or array.
@@ -102,14 +102,14 @@ abstract class CRM_Queue_Queue {
   public abstract function createItem($data, $options = array());
 
   /**
-   * Determine number of items remaining in the queue
+   * Determine number of items remaining in the queue.
    *
    * @return int
    */
   public abstract function numberOfItems();
 
   /**
-   * Get the next item
+   * Get the next item.
    *
    * @param int $lease_time
    *   Seconds.
@@ -131,7 +131,7 @@ abstract class CRM_Queue_Queue {
   public abstract function stealItem($lease_time = 3600);
 
   /**
-   * Remove an item from the queue
+   * Remove an item from the queue.
    *
    * @param object $item
    *   The item returned by claimItem.
@@ -139,7 +139,7 @@ abstract class CRM_Queue_Queue {
   public abstract function deleteItem($item);
 
   /**
-   * Return an item that could not be processed
+   * Return an item that could not be processed.
    *
    * @param object $item
    *   The item returned by claimItem.