From fffe9ee184e24329ff99969ec36fbfbde2016c09 Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Sat, 24 May 2014 14:07:57 +1200
Subject: [PATCH] comment fixes

---
 CRM/Contact/BAO/Query.php | 15 +++++++--------
 CRM/Core/Form.php         |  6 +++---
 2 files changed, 10 insertions(+), 11 deletions(-)

diff --git a/CRM/Contact/BAO/Query.php b/CRM/Contact/BAO/Query.php
index c388494e28..7546401ebd 100644
--- a/CRM/Contact/BAO/Query.php
+++ b/CRM/Contact/BAO/Query.php
@@ -1255,8 +1255,7 @@ class CRM_Contact_BAO_Query {
    * @param boolean $sortByChar
    * @param boolean $groupContacts
    *
-   * @return the sql string for that query (this will most likely
-   * change soon)
+   * @return array sql query parts as an array
    * @access public
    */
   function query($count = FALSE, $sortByChar = FALSE, $groupContacts = FALSE) {
@@ -1772,7 +1771,7 @@ class CRM_Contact_BAO_Query {
    * Given a list of conditions in params generate the required
    * where clause
    *
-   * @return void
+   * @return string
    * @access public
    */
   function whereClause() {
@@ -4164,7 +4163,7 @@ civicrm_relationship.is_permission_a_b = 0
    *
    * @param int $mode
    *
-   * @return void
+   * @return array derault return properties
    * @access public
    */
   static function &defaultReturnProperties($mode = 1) {
@@ -4246,7 +4245,7 @@ civicrm_relationship.is_permission_a_b = 0
    *
    * @param int $value
    *
-   * @return void
+   * @return string|NULL
    * @access public
    */
   static function getPrimaryCondition($value) {
@@ -4807,7 +4806,7 @@ SELECT COUNT( conts.total_amount ) as cancel_count,
   /**
    * default set of return default hier return properties
    *
-   * @return void
+   * @return array
    * @access public
    */
   static function &defaultHierReturnProperties() {
@@ -5430,7 +5429,7 @@ AND   displayRelType.is_active = 1
   /**
    * convert the pseudo constants id's to their names
    *
-   * @param  reference parameter $dao
+   * @param CRM_Core_DAO reference $dao
    * @param bool $return
    *
    * @return array
@@ -5499,7 +5498,7 @@ AND   displayRelType.is_active = 1
 
   /**
    * include pseudo fields LEFT JOIN
-   * @param  $sort  can be a object or string
+   * @param string|array $sort  can be a object or string
    *
    * @return array
    */
diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php
index e32635b473..55a36e4ade 100644
--- a/CRM/Core/Form.php
+++ b/CRM/Core/Form.php
@@ -137,7 +137,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
    * If u have multiple groups of checkboxes, you will need to give them different
    * ids to avoid potential name collision
    *
-   * @var const string / int
+   * @var string|int
    */
   CONST CB_PREFIX = 'mark_x_', CB_PREFIY = 'mark_y_', CB_PREFIZ = 'mark_z_', CB_PREFIX_LEN = 7;
 
@@ -148,12 +148,12 @@ class CRM_Core_Form extends HTML_QuickForm_Page {
    * of default convenient functions, rules and buttons
    *
    * @param object $state State associated with this form
-   * @param \const|\enum $action The mode the form is operating in (None/Create/View/Update/Delete)
+   * @param \const|\enum|int $action The mode the form is operating in (None/Create/View/Update/Delete)
    * @param string $method The type of http method used (GET/POST)
    * @param string $name The name of the form if different from class name
    *
    * @return \CRM_Core_Form
-  @access public
+   * @access public
    */
   function __construct(
     $state = NULL,
-- 
2.25.1