Merge pull request #4806 from civicrm/4.5

[civicrm-core.git] / api / v3 / Generic / Update.php

diff --git a/api/v3/Generic/Update.php b/api/v3/Generic/Update.php
index 3c37f70b548cef613f0da34491e19878e65652bc..02743a2c11d95b837e120c5487c9e5e057982927 100644 (file)
--- a/api/v3/Generic/Update.php
+++ b/api/v3/Generic/Update.php
@@ -2,9 +2,9 @@
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -35,12 +35,14 @@
  * To do this, perform a 'get' action to load the existing values, then merge in the updates
  * and call 'create' to save the revised entity.
  *
- * @param $apiRequest an array with keys:
+ * @param array $apiRequest array with keys:
  *  - entity: string
  *  - action: string
  *  - version: string
  *  - function: callback (mixed)
  *  - params: array, varies
+ *
+ * @return array|int|mixed
  */
 function civicrm_api3_generic_update($apiRequest) {
   //$key_id = strtolower ($apiRequest['entity'])."_id";
@@ -70,4 +72,3 @@ function civicrm_api3_generic_update($apiRequest) {
   $p = array_merge($existing, $apiRequest['params']);
   return civicrm_api($apiRequest['entity'], 'create', $p);
 }
-