Merge pull request #6356 from monishdeb/CRM-16931

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

diff --git a/api/v3/EntityTag.php b/api/v3/EntityTag.php
index 41ac2e108f781e7ce816acf06339eacf791c2086..c775318defaac7321176be0a3b80d3956e83b21f 100644 (file)
--- a/api/v3/EntityTag.php
+++ b/api/v3/EntityTag.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,17 +26,12 @@
  */
 
 /**
- * File for the CiviCRM APIv3 entity tag functions
+ * This api exposes CiviCRM EntityTag records.
  *
- * @package CiviCRM_APIv3
- * @subpackage API_EntityTag
+ * Use this api to add/remove tags from a contact/activity/etc.
+ * To create/update/delete the tags themselves, use the Tag api.
  *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: EntityTag.php 30879 2010-11-22 15:45:55Z shot $
- */
-
-/**
- * Include utility functions
+ * @package CiviCRM_APIv3
  */
 
 /**
@@ -58,7 +53,7 @@ function civicrm_api3_entity_tag_get($params) {
     foreach ($values as $v) {
       $result[$v] = array('tag_id' => $v);
     }
-    return civicrm_api3_create_success($result, $params);
+    return civicrm_api3_create_success($result, $params, 'EntityTag');
   }
 }
 
@@ -68,7 +63,7 @@ function civicrm_api3_entity_tag_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_entity_tag_get_spec(&$params) {
   $params['entity_id']['api.aliases'] = array('contact_id');