From 3ab5efa91a7159bd335f0da50545fea6ac947497 Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Tue, 13 Jan 2015 14:33:40 +1300
Subject: [PATCH] fix a few more comments

---
 CRM/Core/Error.php                                  | 4 ++--
 CRM/Core/Smarty/plugins/function.crmAPI.php         | 3 +++
 CRM/Core/Smarty/plugins/prefilter.resetExtScope.php | 3 +++
 CRM/Event/Form/Registration.php                     | 5 ++---
 CRM/Mailing/BAO/Mailing.php                         | 2 +-
 CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php         | 4 ++--
 6 files changed, 13 insertions(+), 8 deletions(-)

diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php
index 896e5146a1..8a16fa3652 100644
--- a/CRM/Core/Error.php
+++ b/CRM/Core/Error.php
@@ -953,8 +953,8 @@ class CRM_Core_Error extends PEAR_ErrorStack {
   }
 
   /**
-   * @param $error
-   * @param const $type
+   * @param array $error
+   * @param int $type
    *
    * @return bool
    */
diff --git a/CRM/Core/Smarty/plugins/function.crmAPI.php b/CRM/Core/Smarty/plugins/function.crmAPI.php
index 973fec9817..aeb1795ef3 100644
--- a/CRM/Core/Smarty/plugins/function.crmAPI.php
+++ b/CRM/Core/Smarty/plugins/function.crmAPI.php
@@ -34,6 +34,9 @@
  */
 
 /**
+ * @param $params
+ * @param $smarty
+ * @return string|void
  */
 function smarty_function_crmAPI($params, &$smarty) {
   if (!array_key_exists('action', $params)) {
diff --git a/CRM/Core/Smarty/plugins/prefilter.resetExtScope.php b/CRM/Core/Smarty/plugins/prefilter.resetExtScope.php
index e7b6501e7b..88bb6382c0 100644
--- a/CRM/Core/Smarty/plugins/prefilter.resetExtScope.php
+++ b/CRM/Core/Smarty/plugins/prefilter.resetExtScope.php
@@ -3,6 +3,9 @@
 /**
  * Wrap every Smarty template in a {crmScope} tag that sets the
  * variable "extensionKey" to blank.
+ * @param $tpl_source
+ * @param $smarty
+ * @return string
  */
 function smarty_prefilter_resetExtScope($tpl_source, &$smarty) {
   return
diff --git a/CRM/Event/Form/Registration.php b/CRM/Event/Form/Registration.php
index ee8791049c..d5afd4e341 100644
--- a/CRM/Event/Form/Registration.php
+++ b/CRM/Event/Form/Registration.php
@@ -826,10 +826,9 @@ class CRM_Event_Form_Registration extends CRM_Core_Form {
   /**
    * Process the participant
    *
-   * @param array $params
+   * @param CRM_Core_Form $form
    * @param int $contactID
-   *
-   * @return void
+   * @return \CRM_Event_BAO_Participant
    */
   public static function addParticipant(&$form, $contactID) {
     if (empty($form->_params)) {
diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php
index a51530a1ea..97ecd92d29 100644
--- a/CRM/Mailing/BAO/Mailing.php
+++ b/CRM/Mailing/BAO/Mailing.php
@@ -898,7 +898,7 @@ ORDER BY   i.contact_id, i.{$tempColumn}
    *  structures to represent the order in which tokens were found from left to right, top to bottom.
    *
    *
-   * @param string $propName of the property that holds the text that we want to scan for tokens (html, text).
+   * @param string $prop name of the property that holds the text that we want to scan for tokens (html, text).
    *   Name of the property that holds the text that we want to scan for tokens (html, text).
    *
    * @return void
diff --git a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php
index 52f9684ed0..976729cbc0 100644
--- a/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php
+++ b/CRM/Upgrade/Snapshot/V4p2/Price/BAO/Set.php
@@ -1132,11 +1132,11 @@ GROUP BY     mt.member_of_contact_id";
    *
    * @param int $id
    *   Id of the database record.
-   * @param bool $isQuickConfigValue we want to set the is_quick_config field.
+   * @param bool $isQuickConfig we want to set the is_quick_config field.
    *   Value we want to set the is_quick_config field.
    *
    * @return Object
-   *   DAO object on sucess, null otherwise
+   *   DAO object on success, null otherwise
    */
   public static function setIsQuickConfig($id, $isQuickConfig) {
     return CRM_Core_DAO::setFieldValue('CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set', $id, 'is_quick_config', $isQuickConfig);
-- 
2.25.1