INFRA-132 - Batch 14 (g)

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

diff --git a/api/v3/Im.php b/api/v3/Im.php
index fd5e78230df60ea21dd1e19856bdb10d959cd22c..f117aec3004e68a414834b1e79f5f2cdfe21436f 100644 (file)
--- a/api/v3/Im.php
+++ b/api/v3/Im.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -40,10 +40,10 @@
  * Allowed @params array keys are:
  * {@getfields im_create}
  *
- * @param $params
+ * @param array $params
  *
- * @return array of newly created IM property values.
- * @access public
+ * @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);
@@ -53,7 +53,8 @@ function civicrm_api3_im_create($params) {
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_im_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
@@ -62,12 +63,11 @@ function _civicrm_api3_im_create_spec(&$params) {
 /**
  * Deletes an existing IM
  *
- * @param  array  $params
+ * @param array $params
  * {@getfields im_delete}
  *
- * @return array API result Array
- * @access public
- * @todo convert to using Basic delete - BAO function non standard
+ * @return array
+ *   API result Array
  */
 function civicrm_api3_im_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -76,15 +76,15 @@ function civicrm_api3_im_delete($params) {
 /**
  * Retrieve one or more IM
  *
- * @param  mixed[]  (reference ) input parameters
+ * @param mixed[] (reference ) input parameters
  * {@getfields im_get}
- * @param  array $params  an associative array of name/value pairs.
+ * @param array $params
+ *   An associative array of name/value pairs.
  *
- * @return  array details of found IM
+ * @return array
+ *   details of found IM
  *
- * @access public
  */
 function civicrm_api3_im_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-