Merge pull request #3158 from eileenmcnaughton/tests

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

diff --git a/api/v3/Constant.php b/api/v3/Constant.php
index b7987c3b8aebfae567f24ecde26704ecc73e1998..27552311b5d4e0139d9c6bd36fe4786710ca2803 100644 (file)
--- a/api/v3/Constant.php
+++ b/api/v3/Constant.php
@@ -2,9 +2,9 @@
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -27,18 +27,18 @@
  */
 
 /**
- * File for CiviCRM APIv3 pseudoconstants
+ * CiviCRM APIv3 pseudoconstants
  *
+ * @deprecated
  * @package CiviCRM_APIv3
  * @subpackage API_Constant
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * @version $Id: Constant.php 30171 2010-10-14 09:11:27Z mover $
- *
  */
 
 /**
- * Generic file to retrieve all the constants and
- * pseudo constants used in CiviCRM
+ * @deprecated as of CiviCRM 4.4.
+ * It's recommended to use the api getoptions action instead
  *
  *  @param  string  Name of a public static method of
  *                  CRM_Core_PseudoContant: one of
@@ -84,6 +84,7 @@
  *    <li>worldRegion</li>
  *    <li>wysiwygEditor</li>
  *  </ul>
+ * @return array
  *  @example ConstantGet.php
  *  {@getfields constant_get}
  */