a few random comment fixes

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

diff --git a/api/v3/Event.php b/api/v3/Event.php
index 410e37068f46c513897a34be9296c3bf520c15dc..3a3251bc32d40c8d48dc4451faedf1afe9793d26 100644 (file)
--- a/api/v3/Event.php
+++ b/api/v3/Event.php
@@ -85,6 +85,7 @@ function _civicrm_api3_event_create_spec(&$params) {
  * The main purpose of the API is to provide integrators a level of stability not provided by
  * the core code or schema - this means we have to provide support for api calls (where possible)
  * across schema changes.
+ * @param $params
  */
 function _civicrm_api3_event_create_legacy_support_42(&$params) {
   if (!empty($params['payment_processor_id'])) {
@@ -171,6 +172,8 @@ function _civicrm_api3_event_get_spec(&$params) {
  * The main purpose of the API is to provide integrators a level of stability not provided by
  * the core code or schema - this means we have to provide support for api calls (where possible)
  * across schema changes.
+ * @param $event
+ * @param $event_id
  */
 function _civicrm_api3_event_get_legacy_support_42(&$event, $event_id) {
   if (!empty($event[$event_id]['payment_processor'])) {
@@ -186,17 +189,14 @@ function _civicrm_api3_event_get_legacy_support_42(&$event, $event_id) {
  *
  * This API is used for deleting a event
  *
- * @param array $paramsArray containing event_id to be deleted.
- *   Array containing event_id to be deleted.
+ * @param $params
+ * @return array
  *
- * @return boolean
- *   true if success, error otherwise
  * @access public
  *   note API has legacy support for 'event_id'
  *  {@getfields event_delete}
  */
 function civicrm_api3_event_delete($params) {
-
   return CRM_Event_BAO_Event::del($params['id']) ? civicrm_api3_create_success() : civicrm_api3_create_error(ts('Error while deleting event'));
 }
 /*