INFRA-132 - Docblock formatting fixes

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

diff --git a/api/v3/UFGroup.php b/api/v3/UFGroup.php
index 1e9cff919e6d4a789b339075aa2f2261d832cbcb..8195102872b9c68b1b25060358cea2ee48b92452 100644 (file)
--- a/api/v3/UFGroup.php
+++ b/api/v3/UFGroup.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -38,7 +37,7 @@
  */
 
 /**
- * Files required for this package
+ * @param array $params
  */
 function _civicrm_api3_uf_group_create_spec(&$params) {
   $session = CRM_Core_Session::singleton();
@@ -51,9 +50,11 @@ function _civicrm_api3_uf_group_create_spec(&$params) {
 /**
  * Use this API to create a new group. See the CRM Data Model for uf_group property definitions
  *
- * @param $params  array   Associative array of property name/value pairs to insert in group.
+ * @param array $params
+ *   Array Associative array of property name/value pairs to insert in group.
  *
- * @return array API result array
+ * @return array
+ *   API result array
  * {@getfields UFGroup_create}
  * @example UFGroupCreate.php
  * @access public
@@ -65,11 +66,13 @@ function civicrm_api3_uf_group_create($params) {
 /**
  * Returns array of uf groups (profiles)  matching a set of one or more group properties
  *
- * @param array $params  (reference) Array of one or more valid
+ * @param array $params
+ *   (reference) Array of one or more valid.
  *                       property_name=>value pairs. If $params is set
  *                       as null, all surveys will be returned
  *
- * @return array   Array of matching profiles
+ * @return array
+ *   Array of matching profiles
  * {@getfields UFGroup_get}
  * @example UFGroupGet.php
  * @access public
@@ -85,7 +88,7 @@ function civicrm_api3_uf_group_get($params) {
  * @param array $params
  *
  *
- * @return true on successful delete or return error
+ * @return array
  * @access public
  * {@getfields UFGroup_delete}
  * @example UFGroupDelete.php
@@ -93,4 +96,3 @@ function civicrm_api3_uf_group_get($params) {
 function civicrm_api3_uf_group_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-