Merge pull request #6378 from johanv/CRM-15991-permission_delete_relationship

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

diff --git a/api/v3/DashboardContact.php b/api/v3/DashboardContact.php
index 53bef6a33aebcf97b441ae62ef66838aaf422e1f..444709db210d3771fe970baf920f64d36e8185fd 100644 (file)
--- a/api/v3/DashboardContact.php
+++ b/api/v3/DashboardContact.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -26,12 +26,9 @@
  */
 
 /**
- * File for the CiviCRM APIv3 for Dashboard Contact
+ * This api exposes CiviCRM dashboard contacts.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_ActionSchedule
- *
- * @copyright CiviCRM LLC (c) 2004-2014
  */
 
 /**
@@ -75,7 +72,7 @@ function civicrm_api3_dashboard_contact_get($params) {
  * The metadata is used for setting defaults, documentation & validation.
  *
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_dashboard_contact_create_spec(&$params) {
   unset($params['version']);
@@ -101,12 +98,13 @@ function _civicrm_api3_dashboard_contact_check_params(&$params) {
 }
 
 /**
- * Delete an existing dashboard-contact
+ * Delete an existing dashboard-contact.
  *
  * This method is used to delete any existing dashboard-board. the id of the dashboard-contact
  * is required field in $params array
  *
  * @param array $params
+ *
  * @return array
  * @throws \API_Exception
  */