CRM-16019 - Expose date/time format preferences to clientside

[civicrm-core.git] / api / v3 / Campaign.php

diff --git a/api/v3/Campaign.php b/api/v3/Campaign.php
index 3aee6f4c818f0efd41b8026c80a5900c83a81fb8..3f56d470bba711f2a6f3a15569869d51c9eb9019 100644 (file)
--- a/api/v3/Campaign.php
+++ b/api/v3/Campaign.php
@@ -26,15 +26,15 @@
  */
 
 /**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM Campaign records.
+ *
+ * @note Campaign component must be enabled.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Campaign
- * @copyright CiviCRM LLC (c) 2004-2014
  */
 
 /**
- * create/update campaign
+ * Create/update Campaign.
  *
  * This API is used to create new campaign or update any of the existing
  * In case of updating existing campaign, id of that particular campaign must
@@ -49,18 +49,19 @@ function civicrm_api3_campaign_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_campaign_create_spec(&$params) {
   $params['title']['api.required'] = 1;
 }
 
 /**
- * Returns array of campaigns  matching a set of one or more group properties
+ * Returns array of campaigns matching a set of one or more properties.
  *
  * @param array $params
  *   Array per getfields
@@ -73,10 +74,10 @@ function civicrm_api3_campaign_get($params) {
 }
 
 /**
- * delete an existing campaign
+ * Delete an existing campaign.
  *
- * This method is used to delete any existing campaign. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete any existing campaign.
+ * Id of the campaign to be deleted is required field in $params array
  *
  * @param array $params
  *   array containing id of the group to be deleted