INFRA-132 add full stops
[civicrm-core.git] / CRM / Core / JobManager.php
index 7445d4c51dc8a2e9988d44be5ba85f2eb1cb764c..6798a12f832f365b53c39642fcfa17e3ac95cf37 100644 (file)
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * This interface defines methods that need to be implemented
@@ -51,12 +51,10 @@ class CRM_Core_JobManager {
   var $_source = NULL;
 
 
-  /*
-   * Class constructor
-   *
-   * @param void
-   */
   /**
+   * Class constructor.
+   *
+   * @return void
    */
   public function __construct() {
     $config = CRM_Core_Config::singleton();
@@ -65,10 +63,6 @@ class CRM_Core_JobManager {
     $this->jobs = $this->_getJobs();
   }
 
-  /*
-   *
-   * @param void
-   */
   /**
    * @param bool $auth
    */
@@ -93,10 +87,8 @@ class CRM_Core_JobManager {
     $this->logEntry('Finishing scheduled jobs execution.');
   }
 
-  /*
-   * Class destructor
-   *
-   * @param void
+  /**
+   * Class destructor.
    */
   public function __destruct() {
   }
@@ -145,17 +137,13 @@ class CRM_Core_JobManager {
     $this->currentJob = FALSE;
   }
 
-  /*
+  /**
    * Retrieves the list of jobs from the database,
    * populates class param.
    *
-   * @param void
    * @return array
    *   ($id => CRM_Core_ScheduledJob)
    */
-  /**
-   * @return array
-   */
   private function _getJobs() {
     $jobs = array();
     $dao = new CRM_Core_DAO_Job();
@@ -170,13 +158,10 @@ class CRM_Core_JobManager {
     return $jobs;
   }
 
-  /*
-   * Retrieves specific job from the database by id
+  /**
+   * Retrieves specific job from the database by id.
    * and creates ScheduledJob object.
    *
-   * @param void
-   */
-  /**
    * @param int $id
    * @param null $entity
    * @param null $action
@@ -213,12 +198,11 @@ class CRM_Core_JobManager {
     $this->singleRunParams[$key]['version'] = 3;
   }
 
-  /*
-   *
-   * @return array|null collection of permissions, null if none
-   */
   /**
-   * @param $message
+   * @param string $message
+   *
+   * @return void
+   *   collection of permissions, null if none
    */
   public function logEntry($message) {
     $domainID = CRM_Core_Config::domainID();
@@ -271,6 +255,7 @@ class CRM_Core_JobManager {
     $message = $apiResult['is_error'] ? ', Error message: ' . $msg : " (" . $vals . ")";
     return $status . $message;
   }
+
 }
 
 /**