Fix inaccuracies and mistakes in comments

(especially phpdoc comments)

CRM/Batch/BAO/Batch.php

@@ -57,7 +57,7 @@ public static function create(&$params) {
    * @param array $defaults
    *   (reference ) an assoc array to hold the flattened values.
    *
-   * @return array
+   * @return CRM_Batch_BAO_Batch|null
    *   CRM_Batch_BAO_Batch object on success, null otherwise
    */
   public static function retrieve(&$params, &$defaults) {
@@ -364,7 +364,7 @@ public static function getBatchCount(&$params) {
    * @param array $params
    *   Associated array for params.
    *
-   * @return string
+   * @return string[]
    */
   public static function whereClause($params) {
     $clauses = [];

CRM/Core/BAO/CustomGroup.php

@@ -1814,7 +1814,7 @@ public static function formatGroupTree($groupTree, $groupCount = 1, &$form = NUL
       $formattedGroupTree[$key]['collapse_adv_display'] = $value['collapse_adv_display'] ?? NULL;
       $formattedGroupTree[$key]['style'] = $value['style'] ?? NULL;
 
-      // this params needed of bulding multiple values
+      // this params needed of building multiple values
       $formattedGroupTree[$key]['is_multiple'] = $value['is_multiple'] ?? NULL;
       $formattedGroupTree[$key]['extends'] = $value['extends'] ?? NULL;
       $formattedGroupTree[$key]['extends_entity_column_id'] = $value['extends_entity_column_id'] ?? NULL;

CRM/Core/BAO/Website.php

@@ -119,7 +119,7 @@ public static function del($id) {
    * @param array $params
    * @param $values
    *
-   * @return bool
+   * @return array
    */
   public static function &getValues(&$params = [], &$values = []) {
     $websites = [];

CRM/Core/Reference/Basic.php

@@ -15,7 +15,7 @@ class CRM_Core_Reference_Basic implements CRM_Core_Reference_Interface {
   /**
    * @param $refTable
    * @param $refKey
-   * @param null $targetTable
+   * @param string $targetTable
    * @param string $targetKey
    * @param null $refTypeColumn
    */

CRM/Event/BAO/Event.php

@@ -650,13 +650,12 @@ public static function getParticipantCount(
   }
 
   /**
-   * Get the information to map a event.
+   * Get the information to map an event.
    *
    * @param int $id
    *   For which we want map info.
    *
-   * @return null|string
-   *   title of the event
+   * @return array
    */
   public static function &getMapInfo(&$id) {
 
@@ -1261,7 +1260,7 @@ public static function sendMail($contactID, $values, $participantId, $isTest = F
    * @param int $id
    * @param string $name
    * @param int $cid
-   * @param string $template
+   * @param \CRM_Core_Smarty $template
    * @param int $participantId
    * @param bool $isTest
    * @param bool $returnResults
@@ -1663,7 +1662,7 @@ public static function displayProfile(&$params, $gid, &$groupTitle, &$values, &$
                   }
                 }
                 elseif ($dao->data_type == 'Float') {
-                  $customVal = (float ) ($params[$name]);
+                  $customVal = (float) ($params[$name]);
                 }
                 elseif ($dao->data_type == 'Date') {
                   //@todo note the currently we are using default date time formatting. Since you can select/set
@@ -2233,7 +2232,7 @@ public static function getFromEmailIds($eventId = NULL) {
    *
    * @param int $eventId
    *   Event id.
-   * @param sting $extraWhereClause
+   * @param string $extraWhereClause
    *   Extra filter on participants.
    *
    * @return int

CRM/Event/BAO/Participant.php

@@ -798,7 +798,7 @@ public static function resolveDefaults(&$defaults, $reverse = FALSE) {
    *
    * @param array $defaults
    * @param string $property
-   * @param string $lookup
+   * @param string[] $lookup
    * @param bool $reverse
    *
    * @return bool
@@ -1596,8 +1596,7 @@ public static function isPrimaryParticipant($participantId) {
    * @param int $newStatusId
    *   New status.
    *
-   * @return bool
-   *   true if allowed
+   * @return array
    */
   public static function getValidAdditionalIds($participantId, $oldStatusId, $newStatusId) {
 

CRM/Event/Form/ManageEvent/Registration.php

@@ -311,7 +311,7 @@ public function buildRegistrationBlock(&$form) {
    * Subroutine to insert a Profile Editor widget.
    * depends on getProfileSelectorTypes
    *
-   * @param array &$form
+   * @param \CRM_Core_Form &$form
    * @param int $count
    *   Unique index.
    * @param string $prefix
@@ -392,7 +392,6 @@ public function buildConfirmationBlock(&$form) {
    * Build Email Block.
    *
    * @param CRM_Core_Form $form
-   *
    */
   public function buildMailBlock(&$form) {
     $form->registerRule('emailList', 'callback', 'emailList', 'CRM_Utils_Rule');
@@ -421,7 +420,6 @@ public function buildThankYouBlock(&$form) {
   /**
    * Add local and global form rules.
    *
-   *
    * @return void
    */
   public function addRules() {
@@ -621,7 +619,7 @@ public static function formRule($values, $files, $form) {
    * Collect all email fields for an array of profile ids.
    *
    * @param $profileIds
-   * @return bool
+   * @return array
    */
   public static function getEmailFields($profileIds) {
     $emailFields = [];
@@ -771,7 +769,6 @@ public static function addMultipleProfiles(&$profileIds, $values, $field) {
   /**
    * Process the form submission.
    *
-   *
    * @return void
    */
   public function postProcess() {

CRM/Event/Form/Participant.php

@@ -2181,7 +2181,7 @@ protected function getRevenueRecognitionDate() {
   }
 
   /**
-   * Store the parameters to create a payment, if approprite, on the form.
+   * Store the parameters to create a payment, if appropriate, on the form.
    *
    * @param array $params
    *   Params as submitted.

CRM/Event/Page/EventInfo.php

@@ -16,7 +16,7 @@
  */
 
 /**
- * Event Info Page - Summmary about the event
+ * Event Info Page - Summary about the event
  */
 class CRM_Event_Page_EventInfo extends CRM_Core_Page {
 

CRM/Event/Selector/Search.php

@@ -117,7 +117,7 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co
   /**
    * The query object.
    *
-   * @var string
+   * @var CRM_Contact_BAO_Query
    */
   protected $_query;
 

CRM/Extension/Browser.php

@@ -119,7 +119,7 @@ public function checkRequirements() {
   /**
    * Get a list of all available extensions.
    *
-   * @return array
+   * @return CRM_Extension_Info[]
    *   ($key => CRM_Extension_Info)
    */
   public function getExtensions() {
@@ -159,7 +159,7 @@ public function getExtension($key) {
   }
 
   /**
-   * @return array
+   * @return CRM_Extension_Info[]
    * @throws CRM_Extension_Exception_ParseException
    */
   private function _discoverRemote() {

CRM/Extension/Info.php

@@ -23,12 +23,28 @@ class CRM_Extension_Info {
   const FILENAME = 'info.xml';
 
   /**
-   * @var string
+   * @var string|null
    */
   public $key = NULL;
+
+  /**
+   * @var string|null
+   */
   public $type = NULL;
+
+  /**
+   * @var string|null
+   */
   public $name = NULL;
+
+  /**
+   * @var string|null
+   */
   public $label = NULL;
+
+  /**
+   * @var string|null
+   */
   public $file = NULL;
 
   /**
@@ -140,11 +156,11 @@ public static function buildReverseMap($infos) {
   }
 
   /**
-   * @param null $key
-   * @param null $type
-   * @param null $name
-   * @param null $label
-   * @param null $file
+   * @param string|null $key
+   * @param string|null $type
+   * @param string|null $name
+   * @param string|null $label
+   * @param string|null $file
    */
   public function __construct($key = NULL, $type = NULL, $name = NULL, $label = NULL, $file = NULL) {
     $this->key = $key;

CRM/Extension/Mapper.php

@@ -546,7 +546,7 @@ public function refresh() {
    * @todo We should improve this to return more appropriate text. eg. when an extension is not installed
    *   it should not say "version xx is installed".
    *
-   * @param array $remoteExtensionInfo
+   * @param CRM_Extension_Info $remoteExtensionInfo
    * @param array $localExtensionInfo
    *
    * @return string

CRM/Financial/BAO/ExportFormat.php

@@ -214,7 +214,7 @@ public static function createActivityExport($batchIds, $fileName) {
 
   /**
    * @param array $files
-   * @param null $destination
+   * @param string $destination
    * @param bool $overwrite
    *
    * @return bool
@@ -224,7 +224,7 @@ public function createZip($files = [], $destination = NULL, $overwrite = FALSE)
     if (file_exists($destination) && !$overwrite) {
       return FALSE;
     }
-    $valid_files = [];
+
     if (is_array($files)) {
       foreach ($files as $file) {
         // make sure the file exists

CRM/Financial/Form/Export.php

@@ -31,9 +31,11 @@ class CRM_Financial_Form_Export extends CRM_Core_Form {
 
   /**
    * Financial batch ids.
-   * @var array
+   * (comma-separated array)
+   *
+   * @var string
    */
-  protected $_batchIds = [];
+  protected $_batchIds = '';
 
   /**
    * Export status id.

CRM/Logging/Schema.php

@@ -512,7 +512,7 @@ private function _getCreateQuery($table) {
    * Get column query.
    *
    * @param string $col
-   * @param bool $createQuery
+   * @param array $createQuery
    *
    * @return array|mixed|string
    */

CRM/Mailing/BAO/Mailing.php

@@ -995,7 +995,7 @@ public function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email
    * @param bool $isForward
    *   Is this mailing compose for forward?.
    * @param string $fromEmail
-   *   Email address of who is forwardinf it.
+   *   Email address of who is forwarding it.
    *
    * @param null $replyToEmail
    *
@@ -2289,7 +2289,7 @@ public static function mailingACLIDs() {
    * @param int $offset
    *   The row number to start from.
    * @param int $rowCount
-   *   The nmber of rows to return.
+   *   The number of rows to return.
    * @param string $sort
    *   The sql string that describes the sort order.
    *

CRM/Mailing/Event/BAO/Forward.php

@@ -30,8 +30,8 @@ public function __construct() {
    * @param $queue_id
    * @param $hash
    * @param $forward_email
-   * @param null $fromEmail
-   * @param null $comment
+   * @param string|null $fromEmail
+   * @param array|null $comment
    *
    * @return bool
    */

CRM/Mailing/Page/Browse.php

@@ -17,7 +17,7 @@
 
 /**
  * This implements the profile page for all contacts. It uses a selector
- * object to do the actual dispay. The fields displayd are controlled by
+ * object to do the actual display. The fields displayed are controlled by
  * the admin
  */
 class CRM_Mailing_Page_Browse extends CRM_Core_Page {

CRM/Member/Form/MembershipRenewal.php

@@ -638,7 +638,7 @@ protected function submit() {
   /**
    * Send a receipt.
    *
-   * @param array $membership
+   * @param CRM_Member_BAO_Membership $membership
    *
    * @throws \CRM_Core_Exception
    */

CRM/Member/Selector/Search.php

@@ -103,7 +103,7 @@ class CRM_Member_Selector_Search extends CRM_Core_Selector_Base implements CRM_C
   /**
    * The query object.
    *
-   * @var string
+   * @var CRM_Contact_BAO_Query
    */
   protected $_query;
 

CRM/Pledge/Selector/Search.php

@@ -107,7 +107,7 @@ class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base {
   /**
    * The query object
    *
-   * @var string
+   * @var CRM_Contact_BAO_Query
    */
   protected $_query;
 
@@ -428,7 +428,7 @@ public function &getColumnHeaders($action = NULL, $output = NULL) {
   /**
    * Get sql query string.
    *
-   * @return string
+   * @return CRM_Contact_BAO_Query
    */
   public function &getQuery() {
     return $this->_query;

CRM/Price/BAO/LineItem.php

@@ -492,7 +492,7 @@ public static function syncLineItems($entityId, $entityTable, $amount, $otherPar
    * @param array $params
    *   Form values.
    *
-   * @param string $entityId
+   * @param string[]|null $entityId
    *   Entity id.
    *
    * @param string $entityTable