X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FMailingJob.php;h=8d7c030682a6faabb959e506fc0d8ef25251286e;hb=181f536c718a89ac0bf530a89aa936ed3e336122;hp=9d1a70270669bb022c44e01e1f5fe0579c7d3d89;hpb=29d98e1314e345f1b9044f5359c2d0a67f380d21;p=civicrm-core.git

diff --git a/api/v3/MailingJob.php b/api/v3/MailingJob.php
index 9d1a702706..8d7c030682 100644
--- a/api/v3/MailingJob.php
+++ b/api/v3/MailingJob.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,22 +23,20 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
- * APIv3 functions for registering/processing mailing events.
+ * APIv3 functions for registering/processing mailing jobs.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Mailing
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
  */
 
 /**
- * Handle creation of a Mailing Job for a Mailing.
+ * Handle creation of a MailingJob for a Mailing.
+ *
  * @param array $params
+ *
  * @return array
  * @throws \API_Exception
  */
@@ -47,11 +45,12 @@ function civicrm_api3_mailing_job_create($params) {
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_mailing_job_create_spec(&$params) {
   $params['status']['api.default'] = 'Scheduled';
@@ -60,14 +59,12 @@ function _civicrm_api3_mailing_job_create_spec(&$params) {
 }
 
 /**
- * Returns array of Mailing Jobs  matching a set of one or more group properties
+ * Returns array of Mailing Jobs matching a set of one or more group properties.
  *
  * @param array $params
- *   Array of one or more valid.
  *
  * @return array
- *   API return Array of matching mailing jobs
- * {@getfields mailing_job_get}
+ *   API return Array of matching mailing jobs.
  */
 function civicrm_api3_mailing_job_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -75,7 +72,9 @@ function civicrm_api3_mailing_job_get($params) {
 
 /**
  * Handle deletion of a Mailing Job for a Mailing.
+ *
  * @param array $params
+ *
  * @return array
  * @throws \API_Exception
  */