INFRA-132 - Batch 14 (g)

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

diff --git a/api/v3/UFField.php b/api/v3/UFField.php
index d0beca46fabbe0537581edf48f4d0d47c2ec8461..7027417cdf0a5f4e3cc75d4cc64a2dd02275a773 100644 (file)
--- a/api/v3/UFField.php
+++ b/api/v3/UFField.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -40,16 +39,13 @@
 /**
  * Defines 'uf field' within a group.
  *
- * @param $params  array  Associative array of property name/value pairs to create new uf field.
+ * @param array $params
+ *   Array Associative array of property name/value pairs to create new uf field.
  *
  * @throws API_Exception
- * @internal param int $groupId Valid uf_group id
- *
- * @return Newly created $ufFieldArray array
  *
- * @access public
- * {@getfields UFField_create}
- * @example UFFieldCreate.php
+ * @return array
+ *   Newly created $ufFieldArray
  */
 function civicrm_api3_uf_field_create($params) {
   civicrm_api3_verify_one_mandatory($params, NULL, array('field_name', 'uf_group_id'));
@@ -112,9 +108,10 @@ function civicrm_api3_uf_field_create($params) {
 /**
  * Gets field for civicrm_uf_field create
  *
- * @param $params
+ * @param array $params
  *
- * @return array fields valid for other functions
+ * @return array
+ *   fields valid for other functions
  */
 function _civicrm_api3_uf_field_create_spec(&$params) {
   $params['option.autoweight'] = array(
@@ -130,14 +127,15 @@ function _civicrm_api3_uf_field_create_spec(&$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  (reference) Array
+ * @return array
+ *   (reference) Array
  * {@getfields UFField_get
  * @example UFFieldGet.php
- * @access public
  */
 function civicrm_api3_uf_field_get($params) {
   return _civicrm_api3_basic_get('CRM_Core_BAO_UFField', $params);
@@ -146,16 +144,11 @@ function civicrm_api3_uf_field_get($params) {
 /**
  * Delete uf field
  *
- * @param $params
+ * @param array $params
  *
  * @throws API_Exception
- * @internal param int $fieldId Valid uf_field id that to be deleted
- *
- * @return true on successful delete or return error
  *
- * @access public
- * {@getfields UFField_delete}
- * @example UFFieldDelete.php
+ * @return array
  */
 function civicrm_api3_uf_field_delete($params) {
   $fieldId = $params['id'];
@@ -172,11 +165,12 @@ function civicrm_api3_uf_field_delete($params) {
 
   return civicrm_api3_create_success($result, $params);
 }
+
 /**
  * field id accepted for backward compatibility - unset required on id
+ * @param array $params
  */
 function _civicrm_api3_uf_field_delete_spec(&$params) {
   // legacy support for field_id
   $params['id']['api.aliases'] = array('field_id');
 }
-