Merge pull request #5059 from totten/master-validation

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

diff --git a/api/v3/DashboardContact.php b/api/v3/DashboardContact.php
index 4df7815f4b84ede66aaedd72925016569729d45f..86f39aacc550708da9a92ccd9e89c38bbb79c54b 100644 (file)
--- a/api/v3/DashboardContact.php
+++ b/api/v3/DashboardContact.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -24,7 +23,7 @@
  | 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 for Dashboard Contact
@@ -63,7 +62,8 @@ function civicrm_api3_dashboard_contact_create($params) {
 /**
  * Gets a CiviCRM Dashlets of Contacts according to parameters
  *
- * @param array  $params       Associative array of property name/value
+ * @param array $params
+ *   Associative array of property name/value.
  *                             pairs for the activity.
  *
  * @return array
@@ -74,17 +74,19 @@ function civicrm_api3_dashboard_contact_get($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 or parameters determined by getfields.
  */
 function _civicrm_api3_dashboard_contact_create_spec(&$params) {
   unset($params['version']);
 }
 
 /**
- * @param $params
+ * @param array $params
  *
  * @return array|null
  */
@@ -105,8 +107,9 @@ function _civicrm_api3_dashboard_contact_check_params(&$params) {
  * This method is used to delete any existing dashboard-board. the id of the dashboard-contact
  * is required field in $params array
  *
- * {@getfields dashboard_contact_delete}
- * @access public
+ * @param array $params
+ * @return array
+ * @throws \API_Exception
  */
 function civicrm_api3_dashboard_contact_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);