INFRA-132 - Batch 14 (g)

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

diff --git a/api/v3/UFJoin.php b/api/v3/UFJoin.php
index bc8baf6651319f544b052b3d5e85be5b7ab8841e..888501ca61e838cf52df41a7f75d1ff7eeef3357 100644 (file)
--- a/api/v3/UFJoin.php
+++ b/api/v3/UFJoin.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -40,13 +39,11 @@
 /**
  * takes an associative array and creates a uf join in the database
  *
- * @param array $params assoc array of name/value pairs
- *
- * @return array CRM_Core_DAO_UFJoin Array
- * @access public
- * @example UFJoinCreate.php
- *  {@getfields UFJoin_create}
+ * @param array $params
+ *   Assoc array of name/value pairs.
  *
+ * @return array
+ *   CRM_Core_DAO_UFJoin Array
  */
 function civicrm_api3_uf_join_create($params) {
 
@@ -58,7 +55,8 @@ function civicrm_api3_uf_join_create($params) {
 /**
  * Adjust Metadata for Create action
  *
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  * @todo - suspect module, weight don't need to be required - need to test
  */
 function _civicrm_api3_uf_join_create_spec(&$params) {
@@ -70,14 +68,13 @@ function _civicrm_api3_uf_join_create_spec(&$params) {
 /**
  * Get CiviCRM UF_Joins (ie joins between CMS user records & CiviCRM user record
  *
- * @param array $params (reference) an assoc array of name/value pairs
+ * @param array $params
+ *   (reference) an assoc array of name/value pairs.
  *
- * @return array $result CiviCRM Result Array or null
+ * @return array
+ *   CiviCRM Result Array or null
  * @todo Delete function missing
- * @access public
- * {getfields UFJoin_get}
  */
 function civicrm_api3_uf_join_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-