Merge pull request #4865 from eileenmcnaughton/my-first-factory

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

diff --git a/api/v3/Tag.php b/api/v3/Tag.php
index fd87dfde70bf399603cc37b8a45b71d62e5dab69..16029000e6c8b1a4949b3d9c84685ad19e47d0c6 100644 (file)
--- a/api/v3/Tag.php
+++ b/api/v3/Tag.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -42,7 +42,7 @@
  *
  * {@example TagCreate.php}
  *
- * @param $params
+ * @param array $params
  *
  * @return array of newly created tag property values.
  * {@getfields tag_create}
@@ -55,6 +55,8 @@ function civicrm_api3_tag_create($params) {
 /**
  * Specify Meta data for create. Note that this data is retrievable via the getfields function
  * and is used for pre-filling defaults and ensuring mandatory requirements are met.
+ *
+ * @param array $params
  */
 function _civicrm_api3_tag_create_spec(&$params) {
   $params['used_for']['api.default'] = 'civicrm_contact';
@@ -65,11 +67,11 @@ function _civicrm_api3_tag_create_spec(&$params) {
 /**
  * Deletes an existing Tag
  *
- * @param  array  $params
+ * @param array $params
  *
  * @example TagDelete.ph
  *
- * @return boolean | error  true if successfull, error otherwise
+ * @return array API result array
  * {@getfields tag_delete}
  * @access public
  */
@@ -85,7 +87,8 @@ function civicrm_api3_tag_delete($params) {
  *
  * @example TagGet.php
  *
- * @param  array $params  an associative array of name/value pairs.
+ * @param array $params
+ *   An associative array of name/value pairs.
  *
  * @return  array details of found tags else error
  * {@getfields tag_get}
@@ -95,4 +98,3 @@ function civicrm_api3_tag_get($params) {
 
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-