Merge pull request #6595 from eileenmcnaughton/CRM-16996

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

diff --git a/api/v3/Tag.php b/api/v3/Tag.php
index d9b0e2ca0982c5e592e91be73519407255e2f750..30b407d9b731b1eb4439494bda9936acd6fe3f1c 100644 (file)
--- a/api/v3/Tag.php
+++ b/api/v3/Tag.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -26,17 +26,18 @@
  */
 
 /**
- * File for the CiviCRM APIv3 tag functions
+ * This api exposes CiviCRM tags.
  *
- * @package CiviCRM_APIv3
- * @subpackage API_Tag
+ * Tags are used to classify CRM entities (including Contacts, Groups and Actions).
+ *
+ * @note this api is for working with tags themselves. To add/remove tags from
+ * a contact or other entity, use the EntityTag api.
  *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Tag.php 30486 2010-11-02 16:12:09Z shot $
+ * @package CiviCRM_APIv3
  */
 
 /**
- * Add a Tag.
+ * Create or update a tag.
  *
  * Tags are used to classify CRM entities (including Contacts, Groups and Actions).
  *
@@ -44,6 +45,7 @@
  *   Array per getfields metadata.
  *
  * @return array
+ *   API result array
  */
 function civicrm_api3_tag_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -85,7 +87,7 @@ function civicrm_api3_tag_delete($params) {
  *   Array per getfields metadata.
  *
  * @return array
- *   details of found tags else error
+ *   API result array
  */
 function civicrm_api3_tag_get($params) {