X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FSystem.php;h=661e0caf340577e12f4fec501bfd8fe53a54f46a;hb=4b701e6b8127ff1cde029dafd89f794eb65c2fa7;hp=a256b6080bdd23b8c2fc6431b09ad25b047c32da;hpb=a922142c067998cb0ffb4cbc95a71aa370ffdc88;p=civicrm-core.git

diff --git a/api/v3/System.php b/api/v3/System.php
index a256b6080b..661e0caf34 100644
--- a/api/v3/System.php
+++ b/api/v3/System.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -27,30 +26,22 @@
  */
 
 /**
- * File for the CiviCRM APIv3 domain functions
- *
- * @package CiviCRM_APIv3
- * @subpackage API_Domain
+ * This api exposes CiviCRM system functionality.
  *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $
+ * Includes caching, logging, and checking system functionality.
  *
+ * @package CiviCRM_APIv3
  */
 
 /**
- * Flush all system caches
+ * Flush all system caches.
  *
  * @param array $params
  *   Input parameters.
- *                          - triggers: bool, whether to drop/create SQL triggers; default: FALSE
- *                          - session:  bool, whether to reset the CiviCRM session data; defaul: FALSE
- *
- * @return boolean
- *   true if success, else false
- * @static void
- * @access public
- * @example SystemFlush.php
+ *   - triggers: bool, whether to drop/create SQL triggers; default: FALSE
+ *   - session:  bool, whether to reset the CiviCRM session data; default: FALSE
  *
+ * @return array
  */
 function civicrm_api3_system_flush($params) {
   CRM_Core_Invoke::rebuildMenuAndCaches(
@@ -61,11 +52,12 @@ function civicrm_api3_system_flush($params) {
 }
 
 /**
- * Adjust Metadata for Flush action
+ * Adjust Metadata for Flush action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * 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)');
@@ -73,12 +65,13 @@ function _civicrm_api3_system_flush_spec(&$params) {
 }
 
 /**
- * System.Check API specification (optional)
+ * System.Check API specification (optional).
+ *
  * This is used for documentation and validation.
  *
  * @param array $spec
  *   Description of fields supported by this API call.
- * @return void
+ *
  * @see http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  */
 function _civicrm_api3_system_check_spec(&$spec) {
@@ -86,9 +79,10 @@ function _civicrm_api3_system_check_spec(&$spec) {
 }
 
 /**
- * System.Check API
+ * System Check API.
  *
  * @param array $params
+ *
  * @return array
  *   API result descriptor; return items are alert codes/messages
  * @see civicrm_api3_create_success
@@ -106,13 +100,15 @@ function civicrm_api3_system_check($params) {
 }
 
 /**
+ * Log entry to system log table.
+ *
  * @param array $params
  *
  * @return array
  */
 function civicrm_api3_system_log($params) {
   $log = new CRM_Utils_SystemLogger();
-  // this part means fields with separate db storage are accepted as params which kind of seems more intuitive to me
+  // This part means fields with separate db storage are accepted as params which kind of seems more intuitive to me
   // because I felt like not doing this required a bunch of explanation in the spec function - but perhaps other won't see it as helpful?
   if (!isset($params['context'])) {
     $params['context'] = array();
@@ -128,7 +124,8 @@ function civicrm_api3_system_log($params) {
 }
 
 /**
- * Metadata for log function
+ * Metadata for log function.
+ *
  * @param array $params
  */
 function _civicrm_api3_system_log_spec(&$params) {
@@ -163,9 +160,11 @@ function _civicrm_api3_system_log_spec(&$params) {
 }
 
 /**
- * System.Get API
+ * System.Get API.
  *
- * @param arary $params
+ * @param array $params
+ *
+ * @return array
  */
 function civicrm_api3_system_get($params) {
   $returnValues = array(