Merge pull request #3679 from yashodha/CRM-14951

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

diff --git a/api/v3/Constant.php b/api/v3/Constant.php
index c4d0d614ca601227616bf4cfd6b14f57e2eba3c7..f7dcd5e276a161643fe352ac412a6144ea9448a5 100644 (file)
--- a/api/v3/Constant.php
+++ b/api/v3/Constant.php
@@ -2,9 +2,9 @@
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -27,17 +27,17 @@
  */
 
 /**
- * CiviCRM APIv3 pseudoconstants - DEPRECATED
+ * 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 $
- *
  */
 
 /**
- * This api is DEPRECATED as of CiviCRM 4.4.
+ * @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
@@ -84,6 +84,7 @@
  *    <li>worldRegion</li>
  *    <li>wysiwygEditor</li>
  *  </ul>
+ * @return array
  *  @example ConstantGet.php
  *  {@getfields constant_get}
  */
@@ -127,6 +128,9 @@ function civicrm_api3_constant_get($params) {
   return civicrm_api3_create_error('Unknown civicrm constant or method not callable');
 }
 
+/**
+ * @param $params
+ */
 function _civicrm_api3_constant_get_spec(&$params) {
 
   $params = (array