handle recurring entity delete

[civicrm-core.git] / CRM / Core / BAO / Job.php

diff --git a/CRM/Core/BAO/Job.php b/CRM/Core/BAO/Job.php
index 195860df7cb6e575fbef2cb570542bcc734e6bdd..0053f5a54845cd5ccd21c4c0a2f958b7a8ebe44a 100644 (file)
--- a/CRM/Core/BAO/Job.php
+++ b/CRM/Core/BAO/Job.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id: $
  *
  */
@@ -44,16 +44,17 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job {
   function __construct() {
     parent::__construct();
   }
+
   /**
    * Function to add the payment-processor type in the db
    *
    * @param array $params (reference ) an assoc array of name/value pairs
-   * @param array $ids    the array that holds all the db ids
+   *
+   * @internal param array $ids the array that holds all the db ids
    *
    * @return object CRM_Financial_DAO_PaymentProcessorType
    * @access public
    * @static
-   *
    */
   static function create($params) {
     $job = new CRM_Core_DAO_Job();
@@ -101,8 +102,11 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job {
   /**
    * Function  to delete scheduled job
    *
-   * @param  int  $jobId     ID of the job to be deleted.
+   * @param $jobID
+   *
+   * @internal param int $jobId ID of the job to be deleted.
    *
+   * @return bool|null
    * @access public
    * @static
    */