From 5af77f03d308a516080fbb9fb9a6a29a6ada2d45 Mon Sep 17 00:00:00 2001
From: eileen <emcnaughton@wikimedia.org>
Date: Mon, 14 Nov 2016 17:47:46 +1300
Subject: [PATCH] Comment tidy-ups

---
 CRM/Contact/BAO/Contact/Permission.php |  6 ++++--
 CRM/Contact/Form/Merge.php             | 20 +++++++++++++-------
 CRM/Core/Invoke.php                    |  2 --
 3 files changed, 17 insertions(+), 11 deletions(-)

diff --git a/CRM/Contact/BAO/Contact/Permission.php b/CRM/Contact/BAO/Contact/Permission.php
index 1410c54d83..3589c2a360 100644
--- a/CRM/Contact/BAO/Contact/Permission.php
+++ b/CRM/Contact/BAO/Contact/Permission.php
@@ -197,7 +197,7 @@ WHERE contact_a.id = %1 AND $permission
   public static function cache($userID, $type = CRM_Core_Permission::VIEW, $force = FALSE) {
     // FIXME: maybe find a better way of keeping track of this. @eileen pointed out
     //   that somebody might flush the cache away from under our feet,
-    //   but the altenative would be a SQL call every time this is called,
+    //   but the alternative would be a SQL call every time this is called,
     //   and a complete rebuild if the result was an empty set...
     static $_processed = array(
       CRM_Core_Permission::VIEW => array(),
@@ -305,7 +305,9 @@ AND ac.user_id IS NULL
   }
 
   /**
-   * Generate acl subquery that can be placed in the WHERE clause of a query or the ON clause of a JOIN
+   * Generate acl subquery that can be placed in the WHERE clause of a query or the ON clause of a JOIN.
+   *
+   * This is specifically for VIEW operations.
    *
    * @return string|null
    */
diff --git a/CRM/Contact/Form/Merge.php b/CRM/Contact/Form/Merge.php
index b574c3115e..5db35bb1bd 100644
--- a/CRM/Contact/Form/Merge.php
+++ b/CRM/Contact/Form/Merge.php
@@ -35,11 +35,11 @@
  * Class CRM_Contact_Form_Merge.
  */
 class CRM_Contact_Form_Merge extends CRM_Core_Form {
-  // the id of the contact that tere's a duplicate for; this one will
-  // possibly inherit some of $_oid's properties and remain in the system
+  // The id of the contact that there's a duplicate for; this one will
+  // possibly inherit some of $_oid's properties and remain in the system.
   var $_cid = NULL;
 
-  // the id of the other contact - the duplicate one that will get deleted
+  // The id of the other contact - the duplicate one that will get deleted.
   var $_oid = NULL;
 
   var $_contactType = NULL;
@@ -51,10 +51,16 @@ class CRM_Contact_Form_Merge extends CRM_Core_Form {
    */
   var $limit;
 
-  // FIXME: QuickForm can't create advcheckboxes with value set to 0 or '0' :(
-  // see HTML_QuickForm_advcheckbox::setValues() - but patching that doesn't
-  // help, as QF doesn't put the 0-value elements in exportValues() anyway...
-  // to side-step this, we use the below UUID as a (re)placeholder
+  /**
+   * String for quickform bug handling.
+   *
+   * FIXME: QuickForm can't create advcheckboxes with value set to 0 or '0' :(
+   * see HTML_QuickForm_advcheckbox::setValues() - but patching that doesn't
+   * help, as QF doesn't put the 0-value elements in exportValues() anyway...
+   * to side-step this, we use the below UUID as a (re)placeholder
+   *
+   * @var string
+   */
   var $_qfZeroBug = 'e8cddb72-a257-11dc-b9cc-0016d3330ee9';
 
   public function preProcess() {
diff --git a/CRM/Core/Invoke.php b/CRM/Core/Invoke.php
index 35158067b8..01d47f6c22 100644
--- a/CRM/Core/Invoke.php
+++ b/CRM/Core/Invoke.php
@@ -32,8 +32,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2016
- * $Id$
- *
  */
 class CRM_Core_Invoke {
 
-- 
2.25.1