CRM-16036 Eileen in prog

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

diff --git a/api/v3/Im.php b/api/v3/Im.php
index 39dcb176af271d56ed8384ff7068a0ae6464ddaa..e2e7e74a53932b4de40ad17c19142b3be88321b5 100644 (file)
--- a/api/v3/Im.php
+++ b/api/v3/Im.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,45 +23,39 @@
  | 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 IM functions
+ * This api exposes CiviCRM IM records.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_IM
- *
- * @copyright CiviCRM LLC (c) 2004-2014
  */
 
 /**
- *  Add an IM for a contact
- *
- * Allowed @params array keys are:
- * {@getfields im_create}
+ * Add an IM for a contact.
  *
  * @param array $params
  *
  * @return array
- *   Array of newly created IM property values.
  */
 function civicrm_api3_im_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.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_im_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
 }
 
 /**
- * Deletes an existing IM
+ * Deletes an existing IM.
  *
  * @param array $params
  *
@@ -73,16 +67,13 @@ function civicrm_api3_im_delete($params) {
 }
 
 /**
- * Retrieve one or more IM
+ * Retrieve one or more IM.
  *
- * @param mixed[] (reference ) input parameters
- * {@getfields im_get}
  * @param array $params
  *   An associative array of name/value pairs.
  *
  * @return array
  *   details of found IM
- *
  */
 function civicrm_api3_im_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);