INFRA-132 - Docblock @param and @return tag fixes

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

diff --git a/api/v3/MailingEventResubscribe.php b/api/v3/MailingEventResubscribe.php
index 8410c3c63700917a3e1536f5e3525a4656928688..07edb38c8f4b888a02c0b274f1671ecd3e69f262 100644 (file)
--- a/api/v3/MailingEventResubscribe.php
+++ b/api/v3/MailingEventResubscribe.php
@@ -2,7 +2,7 @@
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -40,10 +40,12 @@
 /**
  * Subscribe from mailing group
  *
- * @param array $params  Associative array of property
+ * @param array $params
+ *   Associative array of property.
  *                       name/value pairs to insert in new 'survey'
  *
- * @return array api result array
+ * @return array
+ *   api result array
  * {@getfields mailing_event_subscribe_create}
  * @access public
  */
@@ -70,7 +72,8 @@ function civicrm_api3_mailing_event_resubscribe_create($params) {
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_mailing_event_resubscribe_create_spec(&$params) {
   $params['event_queue_id']['api.required'] = 1;
@@ -80,4 +83,3 @@ function _civicrm_api3_mailing_event_resubscribe_create_spec(&$params) {
   $params['hash']['api.required'] = 1;
   $params['hash']['title'] = 'Hash';
 }
-