INFRA-132 - Batch 14 (g)

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

diff --git a/api/v3/UFMatch.php b/api/v3/UFMatch.php
index 97ba4b1fe971bd8ed6b67599656ad5335728c757..d57dbb770baf88c07d5fa25e1364a5bd1d2f5caa 100644 (file)
--- a/api/v3/UFMatch.php
+++ b/api/v3/UFMatch.php
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | 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.                                    |
  |                                                                    |
@@ -32,7 +31,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 $
  *
  */
@@ -42,11 +41,7 @@
  *
  * @param array $params
  *
- * @return array $result
- * @access public
- * {@getfields UFMatch_get}
- * @example UFMatchGet.php
- * @todo this class is missing delete & create functions (do after exisitng functions upgraded to v3)
+ * @return array
  */
 function civicrm_api3_uf_match_get($params) {
   return _civicrm_api3_basic_get('CRM_Core_BAO_UFMatch', $params);
@@ -55,13 +50,14 @@ function civicrm_api3_uf_match_get($params) {
 /**
  * Create or update a UF Match record
  *
- * @param array $params  Associative array of property
+ * @param array $params
+ *   Associative array of property.
  *                       name/value pairs to insert in new 'survey'
  * @example UFMatch.php Std Create example
  *
- * @return array api result array
+ * @return array
+ *   api result array
  * {@getfields uf_match_create}
- * @access public
  */
 function civicrm_api3_uf_match_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -71,7 +67,8 @@ function civicrm_api3_uf_match_create($params) {
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_uf_match_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
@@ -82,15 +79,15 @@ function _civicrm_api3_uf_match_create_spec(&$params) {
 /**
  * Create or update a survey
  *
- * @param array $params  Associative array of property
+ * @param array $params
+ *   Associative array of property.
  *                       name/value pairs to insert in new 'survey'
  * @example UFMatch.php Std Create example
  *
- * @return array api result array
+ * @return array
+ *   api result array
  * {@getfields uf_match_create}
- * @access public
  */
 function civicrm_api3_uf_match_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-