Merge pull request #3679 from yashodha/CRM-14951
[civicrm-core.git] / api / v3 / UFGroup.php
index a85a79a88b375f9891744e3e721dd6ab0328e356..bac5560a6a7b037411b2133c5615637cdd086f02 100644 (file)
@@ -2,9 +2,9 @@
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -32,7 +32,7 @@
  * @package CiviCRM_APIv3
  * @subpackage API_UF
  *
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * @version $Id: UFGroup.php 30171 2010-10-14 09:11:27Z mover $
  *
  */
@@ -40,7 +40,6 @@
 /**
  * Files required for this package
  */
-
 function _civicrm_api3_uf_group_create_spec(&$params) {
   $session = CRM_Core_Session::singleton();
   $params['title']['api.required'] = 1;
@@ -54,7 +53,7 @@ function _civicrm_api3_uf_group_create_spec(&$params) {
  *
  * @param $params  array   Associative array of property name/value pairs to insert in group.
  *
- * @return   Newly create $ufGroupArray array
+ * @return array API result array
  * {@getfields UFGroup_create}
  * @example UFGroupCreate.php
  * @access public
@@ -83,7 +82,9 @@ function civicrm_api3_uf_group_get($params) {
 /**
  * Delete uf group
  *
- * @param $groupId int  Valid uf_group id that to be deleted
+ * @param $params
+ *
+ * @internal param int $groupId Valid uf_group id that to be deleted
  *
  * @return true on successful delete or return error
  * @todo doesnt rtn success or error properly