Merge pull request #5010 from eileenmcnaughton/rebase2

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

diff --git a/api/v3/Acl.php b/api/v3/Acl.php
index 2ad97bc28ce91356ab0a23c4dc4be67fa689e497..9bc52f32fb1d2843de2bf03cceaaa1e342d14e2c 100644 (file)
--- a/api/v3/Acl.php
+++ b/api/v3/Acl.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -24,27 +23,25 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * File for the CiviCRM APIv3 acl functions
  *
  * @package CiviCRM_APIv3
  * @subpackage API_acl
- *
  */
 
 /**
  * Save an acl
  *
- * Allowed @params array keys are:
  * {@getfields acl_create}
  * @example aclCreate.php
  *
- * @param $params
+ * @param array $params
  *
- * @return array of newly created acl property values.
- * @access public
+ * @return array
+ *   Array of newly created acl property values.
  */
 function civicrm_api3_acl_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -53,14 +50,13 @@ function civicrm_api3_acl_create($params) {
 /**
  * Get an acl
  *
- * Allowed @params array keys are:
  * {@getfields acl_get}
  * @example aclCreate.php
  *
- * @param $params
+ * @param array $params
  *
- * @return array of retrieved acl property values.
- * @access public
+ * @return array
+ *   Array of retrieved acl property values.
  */
 function civicrm_api3_acl_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -69,14 +65,13 @@ function civicrm_api3_acl_get($params) {
 /**
  * Delete an acl
  *
- * Allowed @params array keys are:
  * {@getfields acl_delete}
  * @example aclCreate.php
  *
- * @param $params
+ * @param array $params
  *
- * @return array of deleted values.
- * @access public
+ * @return array
+ *   Array of deleted values.
  */
 function civicrm_api3_acl_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);