Merge pull request #5901 from colemanw/CRM-16557

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

diff --git a/api/v3/System.php b/api/v3/System.php
index e306cc1cd9ebfdb0d2f687ab7e1c2d02f3d970e0..b60d2d44a14a5dd760ac58cdd1916d1ce5d117d4 100644 (file)
--- a/api/v3/System.php
+++ b/api/v3/System.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,11 +26,11 @@
  */
 
 /**
- * This api exposes CiviCRM system.
+ * This api exposes CiviCRM system functionality.
  *
- * @package CiviCRM_APIv3
- * @subpackage API_Domain
+ * Includes caching, logging, and checking system functionality.
  *
+ * @package CiviCRM_APIv3
  */
 
 /**
@@ -57,11 +57,19 @@ function civicrm_api3_system_flush($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_system_flush_spec(&$params) {
-  $params['triggers'] = array('title' => 'rebuild triggers (boolean)');
-  $params['session'] = array('title' => 'refresh sessions (boolean)');
+  $params['triggers'] = array(
+    'title' => 'Triggers',
+    'description' => 'rebuild triggers (boolean)',
+    'type' => CRM_Utils_Type::T_BOOLEAN,
+  );
+  $params['session'] = array(
+    'title' => 'Sessions',
+    'description' => 'refresh sessions (boolean)',
+    'type' => CRM_Utils_Type::T_BOOLEAN,
+  );
 }
 
 /**
@@ -79,7 +87,7 @@ function _civicrm_api3_system_check_spec(&$spec) {
 }
 
 /**
- * System.Check API.
+ * System Check API.
  *
  * @param array $params
  *