Merge pull request #5473 from aydun/CRM-16160

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

diff --git a/api/v3/SystemLog.php b/api/v3/SystemLog.php
index 403ea7a885c874108d9448473d5ab3d82fe92795..1293a13ac074c6edb0c9cc30bf832cf4c2a23f88 100644 (file)
--- a/api/v3/SystemLog.php
+++ b/api/v3/SystemLog.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,17 +26,14 @@
  */
 
 /**
- * File for the CiviCRM APIv3 SystemLog functions
+ * This api exposes CiviCRM SystemLog.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_SystemLog
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: SystemLog.php 30171 2010-10-14 09:11:27Z mover $
- *
  */
 
 /**
+ * Delete system log record.
+ *
  * @param array $params
  *
  * @return array
@@ -46,9 +43,11 @@ function civicrm_api3_system_log_delete($params) {
 }
 
 /**
- * Create system log
+ * Create system log record.
+ *
  * It's arguable whether this function should exist as it fits our crud pattern and adding it meets our SyntaxConformance test requirements
  * but it just wraps system.log which is more consistent with the PSR3 implemented.
+ *
  * @param array $params
  *
  * @return array
@@ -58,9 +57,9 @@ function civicrm_api3_system_log_create($params) {
 }
 
 /**
- * @param array $params
+ * Adjust system log create metadata.
  *
- * @return void
+ * @param array $params
  */
 function _civicrm_api3_system_log_create_spec(&$params) {
   require_once 'api/v3/System.php';
@@ -68,6 +67,8 @@ function _civicrm_api3_system_log_create_spec(&$params) {
 }
 
 /**
+ * Get system log record.
+ *
  * @param array $params
  *
  * @return array