Merge remote-tracking branch 'origin/4.5' into 4.5-master-2015-02-24-17-24-05

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

diff --git a/api/v3/ReportInstance.php b/api/v3/ReportInstance.php
index feb4c0693a7d6adf61cebb6b8de16ba7c4d8adc0..d51bdaa722bc468d436cb567f6c2addbbce5aa09 100644 (file)
--- a/api/v3/ReportInstance.php
+++ b/api/v3/ReportInstance.php
@@ -1,34 +1,67 @@
 <?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.6                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
 
 /**
- * Retrieve a report instance
+ * This api exposes CiviCRM report instances.
  *
- * @param  array  $params input parameters
+ * @package CiviCRM_APIv3
+ */
+
+/**
+ * Retrieve a report instance.
  *
- * @return  array details of found instances
- * @access public
+ * @param array $params
+ *   Input parameters.
+ *
+ * @return array
+ *   Details of found instances
  */
 function civicrm_api3_report_instance_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- *  Add or update a report instance.
+ * Add or update a report instance.
  *
  * @param array $params
  *
- * @return array of newly created report instance property values.
- * @access public
+ * @return array
  */
 function civicrm_api3_report_instance_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_report_instance_create_spec(&$params) {
   $params['report_id']['api.required'] = 1;
@@ -36,12 +69,12 @@ function _civicrm_api3_report_instance_create_spec(&$params) {
 }
 
 /**
- * Deletes an existing ReportInstance
+ * Deletes an existing ReportInstance.
  *
- * @param  array  $params
+ * @param array $params
  *
- * @return array Api result
- * @access public
+ * @return array
+ *   Api result
  */
 function civicrm_api3_report_instance_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);