X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FActivityContact.php;h=c807420d8bcfbd05b5ee00eae0f3ae4fb35bf7bb;hb=af3775b322b9e4f11d097067367f0ea7763f5f10;hp=b9f744b9362349a1dc19e1f8fc0d45487ed1f44f;hpb=e9aca61e8b08d5ae372621c4397108b8f2ec28ba;p=civicrm-core.git

diff --git a/api/v3/ActivityContact.php b/api/v3/ActivityContact.php
index b9f744b936..c807420d8b 100644
--- a/api/v3/ActivityContact.php
+++ b/api/v3/ActivityContact.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -24,39 +23,33 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * File for the CiviCRM APIv3 activity contact functions
+ * This api exposes the CiviCRM ActivityContact join table.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_ActivityContact
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: ActivityContact.php 2014-04-01 elcapo $
  */
 
 /**
- *  Add a record relating a contact with an activity
- *
- * Allowed @params array keys are:
- *
- * @example ActivityContact.php
+ * Add a record relating a contact with an activity.
  *
  * @param array $params
  *
- * @return array of newly created activity contact records.
- * @access public
+ * @return array
+ *   API result array.
  */
 function civicrm_api3_activity_contact_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $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
+ * @param array $params
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_activity_contact_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
@@ -64,14 +57,12 @@ function _civicrm_api3_activity_contact_create_spec(&$params) {
 }
 
 /**
- * Deletes an existing ActivityContact record
- *
- * @param  array  $params
+ * Delete an existing ActivityContact record.
  *
- * @return array Api Result
+ * @param array $params
  *
- * @example ActivityContact.php
- * @access public
+ * @return array
+ *   Api Result
  */
 function civicrm_api3_activity_contact_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -80,13 +71,11 @@ function civicrm_api3_activity_contact_delete($params) {
 /**
  * Get a ActivityContact.
  *
- * @example ActivityContact.php
- *
- * @param  array $params  an associative array of name/value pairs.
- *
- * @return  array details of found tags else error
+ * @param array $params
+ *   An associative array of name/value pairs.
  *
- * @access public
+ * @return array
+ *   details of found tags else error
  */
 function civicrm_api3_activity_contact_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);