INFRA-132 - Comment grammar cleanup

[civicrm-core.git] / CRM / Core / BAO / UFJoin.php

diff --git a/CRM/Core/BAO/UFJoin.php b/CRM/Core/BAO/UFJoin.php
index 86c2165a58d5b743ea96da7d91c288982386b26d..557e6523b0905a01a4148dc7a806623fa3c07d07 100644 (file)
--- a/CRM/Core/BAO/UFJoin.php
+++ b/CRM/Core/BAO/UFJoin.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -39,12 +39,12 @@
 class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin {
 
   /**
-   * takes an associative array and creates a uf join object
+   * Takes an associative array and creates a uf join object
    *
-   * @param array $params (reference) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference) an assoc array of name/value pairs.
    *
-   * @return object CRM_Core_DAO_UFJoin object
-   * @access public
+   * @return CRM_Core_DAO_UFJoin object
    * @static
    */
   public static function &create($params) {
@@ -66,6 +66,9 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin {
     return $dao;
   }
 
+  /**
+   * @param array $params
+   */
   public static function deleteAll(&$params) {
     $module      = CRM_Utils_Array::value('module', $params);
     $entityTable = CRM_Utils_Array::value('entity_table', $params);
@@ -89,10 +92,10 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin {
    * Given an assoc list of params, find if there is a record
    * for this set of params
    *
-   * @param array $params (reference) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference) an assoc array of name/value pairs.
    *
    * @return int or null
-   * @access public
    * @static
    */
   public static function findJoinEntryId(&$params) {
@@ -126,10 +129,10 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin {
    * Given an assoc list of params, find if there is a record
    * for this set of params and return the group id
    *
-   * @param array $params (reference) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference) an assoc array of name/value pairs.
    *
    * @return int or null
-   * @access public
    * @static
    */
   public static function findUFGroupId(&$params) {
@@ -145,6 +148,11 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin {
     return NULL;
   }
 
+  /**
+   * @param array $params
+   *
+   * @return array
+   */
   public static function getUFGroupIds(&$params) {
 
     $dao = new CRM_Core_DAO_UFJoin();
@@ -173,4 +181,3 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin {
     return array($first, $second, $firstActive, $secondActive);
   }
 }
-