From f3f00653eec6a47b7f20b58be81796f7b546f079 Mon Sep 17 00:00:00 2001
From: eileen <emcnaughton@wikimedia.org>
Date: Tue, 10 Jan 2017 15:02:21 +1300
Subject: [PATCH] A few more comment fixes. Remove unused var rather than
 document it

---
 CRM/Core/BAO/UFGroup.php            | 5 +++--
 CRM/Core/Form.php                   | 2 ++
 CRM/Event/Form/EventFees.php        | 6 +++---
 CRM/Mailing/BAO/Mailing.php         | 5 +++--
 CRM/Mailing/Event/BAO/Delivered.php | 2 ++
 CRM/Mailing/Event/BAO/Opened.php    | 2 ++
 CRM/Report/Form.php                 | 2 ++
 CRM/Utils/Hook.php                  | 9 +++++++--
 8 files changed, 24 insertions(+), 9 deletions(-)

diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php
index 4910f4ad71..de3cb70ce0 100644
--- a/CRM/Core/BAO/UFGroup.php
+++ b/CRM/Core/BAO/UFGroup.php
@@ -943,8 +943,7 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup {
   }
 
   /**
-   * Given a contact id and a field set, return the values from the db
-   * for this contact
+   * Given a contact id and a field set, return the values from the db.
    *
    * @param int $cid
    * @param array $fields
@@ -958,6 +957,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup {
    * @param bool $absolute
    *   Return urls in absolute form (useful when sending an email).
    * @param null $additionalWhereClause
+   *
+   * @return null|array
    */
   public static function getValues(
     $cid, &$fields, &$values,
diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php
index 213dfead88..fadce93d65 100644
--- a/CRM/Core/Form.php
+++ b/CRM/Core/Form.php
@@ -2315,6 +2315,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
    *
    * @param array $params
    *   Form input params, default to $this->_params.
+   *
+   * @return string
    */
   public function assignBillingName($params = array()) {
     $name = '';
diff --git a/CRM/Event/Form/EventFees.php b/CRM/Event/Form/EventFees.php
index d971cdcb41..0a01313035 100644
--- a/CRM/Event/Form/EventFees.php
+++ b/CRM/Event/Form/EventFees.php
@@ -64,10 +64,11 @@ class CRM_Event_Form_EventFees {
   }
 
   /**
-   * This function sets the default values for the form in edit/view mode
-   * the default values are retrieved from the database
+   * This function sets the default values for the form in edit/view mode.
    *
    * @param CRM_Core_Form $form
+   *
+   * @return array
    */
   public static function setDefaultValues(&$form) {
     $defaults = array();
@@ -249,7 +250,6 @@ class CRM_Event_Form_EventFees {
   /**
    * This function sets the default values for price set.
    *
-   *
    * @param int $participantID
    * @param int $eventID
    * @param bool $includeQtyZero
diff --git a/CRM/Mailing/BAO/Mailing.php b/CRM/Mailing/BAO/Mailing.php
index a648d09087..80056cae31 100644
--- a/CRM/Mailing/BAO/Mailing.php
+++ b/CRM/Mailing/BAO/Mailing.php
@@ -3173,10 +3173,11 @@ AND        m.id = %1
   }
 
   /**
-   * Whitelist of possible values for the entity_table field
+   * White-list of possible values for the entity_table field.
+   *
    * @return array
    */
-  public static function mailingGroupEntityTables($context = NULL) {
+  public static function mailingGroupEntityTables() {
     return array(
       CRM_Contact_BAO_Group::getTableName() => 'Group',
       CRM_Mailing_BAO_Mailing::getTableName() => 'Mailing',
diff --git a/CRM/Mailing/Event/BAO/Delivered.php b/CRM/Mailing/Event/BAO/Delivered.php
index 762ea46103..a0d9ecdc06 100644
--- a/CRM/Mailing/Event/BAO/Delivered.php
+++ b/CRM/Mailing/Event/BAO/Delivered.php
@@ -44,6 +44,8 @@ class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered {
    *
    * @param array $params
    *   Associative array of delivery event values.
+   *
+   * @return \CRM_Mailing_Event_BAO_Delivered
    */
   public static function &create(&$params) {
     $q = &CRM_Mailing_Event_BAO_Queue::verify($params['job_id'],
diff --git a/CRM/Mailing/Event/BAO/Opened.php b/CRM/Mailing/Event/BAO/Opened.php
index d8019e8bff..c882eaf096 100644
--- a/CRM/Mailing/Event/BAO/Opened.php
+++ b/CRM/Mailing/Event/BAO/Opened.php
@@ -44,6 +44,8 @@ class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened {
    *
    * @param int $queue_id
    *   The Queue Event ID of the recipient.
+   *
+   * @return bool
    */
   public static function open($queue_id) {
     // First make sure there's a matching queue event.
diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php
index 2c64486c46..bb85fd82d7 100644
--- a/CRM/Report/Form.php
+++ b/CRM/Report/Form.php
@@ -4667,6 +4667,8 @@ LEFT JOIN civicrm_contact {$field['alias']} ON {$field['alias']}.id = {$this->_a
    * @param object $query
    * @param string $alias
    * @param bool $return
+   *
+   * @return string
    */
   public function getPermissionedFTQuery(&$query, $alias = NULL, $return = FALSE) {
     if (!CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
diff --git a/CRM/Utils/Hook.php b/CRM/Utils/Hook.php
index 3f45a8fb71..7e4224e265 100644
--- a/CRM/Utils/Hook.php
+++ b/CRM/Utils/Hook.php
@@ -2199,8 +2199,11 @@ abstract class CRM_Utils_Hook {
   }
 
   /**
-   * This hook is called for bypass a few civicrm urls from IDS check
-   * @param array $skip list of civicrm url;
+   * This hook is called for bypass a few civicrm urls from IDS check.
+   *
+   * @param array $skip list of civicrm urls
+   *
+   * @return mixed
    */
   public static function idsException(&$skip) {
     return self::singleton()->invoke(1, $skip, self::$_nullObject,
@@ -2215,6 +2218,8 @@ abstract class CRM_Utils_Hook {
    * @param string $geoProvider
    * @param array $values
    * @param SimpleXMLElement $xml
+   *
+   * @return mixed
    */
   public static function geocoderFormat($geoProvider, &$values, $xml) {
     return self::singleton()->invoke(3, $geoProvider, $values, $xml,
-- 
2.25.1