comment fixes

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

diff --git a/CRM/Core/BAO/Location.php b/CRM/Core/BAO/Location.php
index 9451db3e400b5d85dbc2dd1f514a5e10c1319d79..f527f9b6b4cc5a77893f50a44422e590a8e87b71 100644 (file)
--- a/CRM/Core/BAO/Location.php
+++ b/CRM/Core/BAO/Location.php
@@ -94,6 +94,11 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO {
 
   /**
    * Creates the entry in the civicrm_loc_block.
+   *
+   * @param string $location
+   * @param array $entityElements
+   *
+   * @return int
    */
   public static function createLocBlock(&$location, &$entityElements) {
     $locId = self::findExisting($entityElements);
@@ -132,6 +137,10 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO {
 
   /**
    * Takes an entity array and finds the existing location block.
+   *
+   * @param array $entityElements
+   *
+   * @return int
    */
   public static function findExisting($entityElements) {
     $eid = $entityElements['entity_id'];
@@ -155,8 +164,8 @@ WHERE e.id = %1";
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
    *
-   * @return object
-   *   CRM_Core_BAO_locBlock object on success, null otherwise
+   * @return CRM_Core_BAO_locBlock
+   *   Object on success, null otherwise
    */
   public static function addLocBlock(&$params) {
     $locBlock = new CRM_Core_DAO_LocBlock();
@@ -228,7 +237,9 @@ WHERE e.id = %1";
   }
 
   /**
-   * @param $entityBlock
+   * Get values.
+   *
+   * @param array $entityBlock
    * @param bool $microformat
    *
    * @return array
@@ -341,12 +352,10 @@ WHERE e.id = %1";
   }
 
   /**
-   * If contact has data for any location block, make sure
-   * contact should have only one primary block, CRM-5051
+   * Make sure contact should have only one primary block, CRM-5051.
    *
    * @param int $contactId
    *   Contact id.
-   *
    */
   public static function checkPrimaryBlocks($contactId) {
     if (!$contactId) {
@@ -388,6 +397,8 @@ WHERE e.id = %1";
   }
 
   /**
+   * Get chain select values (whatever that means!).
+   *
    * @param mixed $values
    * @param string $valueType
    * @param bool $flatten