--CRM-16187, fixed jenkin warnings
[civicrm-core.git] / api / v3 / Acl.php
index 39e3d7ee9d23e504f31fde62c041108c800857e0..3ba552797023a045734ec88d15ce9da8c1c3d9fd 100644 (file)
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
  | 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
+ * This api exposes CiviCRM Acl records.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_acl
- *
  */
 
 /**
- * Save an acl
- *
- * Allowed @params array keys are:
- * {@getfields acl_create}
- * @example aclCreate.php
+ * Save an Acl.
  *
  * @param array $params
  *
  * @return array
- *   Array of newly created acl property values.
- * @access public
  */
 function civicrm_api3_acl_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Get an acl
- *
- * Allowed @params array keys are:
- * {@getfields acl_get}
- * @example aclCreate.php
+ * Get an Acl.
  *
  * @param array $params
  *
  * @return array
- *   Array of retrieved acl property values.
- * @access public
+ *   Array of retrieved Acl property values.
  */
 function civicrm_api3_acl_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Delete an acl
- *
- * Allowed @params array keys are:
- * {@getfields acl_delete}
- * @example aclCreate.php
+ * Delete an Acl.
  *
  * @param array $params
  *
  * @return array
  *   Array of deleted values.
- * @access public
  */
 function civicrm_api3_acl_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);