More comment fixes

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

diff --git a/api/v3/System.php b/api/v3/System.php
index d88a1f22a1375814ce06750370fd126145ae3e3d..92f8c0659112099326fd1e902138f6cab8297ee2 100644 (file)
--- a/api/v3/System.php
+++ b/api/v3/System.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -34,22 +33,17 @@
  *
  * @copyright CiviCRM LLC (c) 2004-2014
  * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $
- *
  */
 
 /**
- * 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
- *
+ * @return array
  */
 function civicrm_api3_system_flush($params) {
   CRM_Core_Invoke::rebuildMenuAndCaches(
@@ -60,9 +54,10 @@ 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.
  */
@@ -72,12 +67,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) {
@@ -85,10 +81,12 @@ 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
+ *
+ * @return array
+ *   API result descriptor; return items are alert codes/messages
  * @see civicrm_api3_create_success
  * @see civicrm_api3_create_error
  * @throws API_Exception
@@ -104,13 +102,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();
@@ -126,7 +126,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) {
@@ -161,9 +162,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(