Various phpdoc fixes

CRM/Activity/BAO/Activity.php

@@ -781,7 +781,7 @@ public static function getActivities($params) {
    * Filter the activity types to only return the ones we actually asked for
    * Uses params['activity_type_id'] and params['activity_type_exclude_id']
    *
-   * @param $params
+   * @param array $params
    * @return array|null (Use in Activity.get API activity_type_id)
    */
   public static function filterActivityTypes($params) {
@@ -2288,7 +2288,7 @@ protected static function getPermittedActivityTypes() {
   }
 
   /**
-   * @param $params
+   * @param array $params
    * @return array
    */
   protected static function getActivityParamsForDashboardFunctions($params) {

CRM/Activity/Form/Task/PDF.php

@@ -94,7 +94,7 @@ public function createDocument($activityIds, $html_message, $formValues) {
   /**
    * Render html from rows
    *
-   * @param $rows
+   * @param array $rows
    * @param string $msgPart
    *   The name registered with the TokenProcessor
    * @param array $formValues

CRM/Contact/BAO/ProximityQuery.php

@@ -35,11 +35,23 @@ class CRM_Contact_BAO_ProximityQuery {
    */
 
   /**
-   * @var string
+   * @var float
    */
   static protected $_earthFlattening;
+
+  /**
+   * @var float
+   */
   static protected $_earthRadiusSemiMinor;
+
+  /**
+   * @var float
+   */
   static protected $_earthRadiusSemiMajor;
+
+  /**
+   * @var float
+   */
   static protected $_earthEccentricitySQ;
 
   public static function initialize() {
@@ -353,9 +365,8 @@ public static function process(&$query, &$values) {
 
   /**
    * @param array $input
-   * retun void
    *
-   * @return null
+   * @return void
    */
   public static function fixInputParams(&$input) {
     foreach ($input as $param) {
@@ -378,7 +389,6 @@ public static function fixInputParams(&$input) {
             }
           }
         }
-        return NULL;
       }
     }
   }

CRM/Contact/Form/Task.php

@@ -227,7 +227,7 @@ public static function preProcessCommon(&$form) {
    * to use a trait based approach. For now this is renamed to
    * permit the use of a non-static function with this name
    *
-   * @param $form CRM_Core_Form
+   * @param CRM_Core_Form_Task $form
    *
    * @return array $contactIds
    */

CRM/Contact/Page/View.php

@@ -231,7 +231,7 @@ public static function getContactDetails($contactId) {
   }
 
   /**
-   * @param $page
+   * @param CRM_Core_Page $page
    * @param int $contactID
    */
   public static function checkUserPermission($page, $contactID = NULL) {
@@ -242,7 +242,7 @@ public static function checkUserPermission($page, $contactID = NULL) {
       $contactID = $page->_contactId;
     }
 
-    // automatically grant permissin for users on their own record. makes
+    // automatically grant permission for users on their own record. makes
     // things easier in dashboard
     $session = CRM_Core_Session::singleton();
 

CRM/Core/BAO/CustomOption.php

@@ -167,7 +167,7 @@ public static function getOptionListSelector(&$params) {
   /**
    * Delete Option.
    *
-   * @param $optionId integer
+   * @param int $optionId
    *   option id
    *
    */

CRM/Core/BAO/EntityTag.php

@@ -297,7 +297,8 @@ public static function create(&$params, $entityTable, $entityID) {
    * @param int $contactID
    * @param bool $count
    *
-   * @return array
+   * @return array|int
+   *   Dependant on $count
    */
   public static function getContactTags($contactID, $count = FALSE) {
     $contactTags = [];
@@ -319,7 +320,7 @@ public static function getContactTags($contactID, $count = FALSE) {
 
     if ($count) {
       $dao->fetch();
-      return $dao->cnt;
+      return (int) $dao->cnt;
     }
 
     while ($dao->fetch()) {
@@ -368,7 +369,7 @@ public static function getChildEntityTags($parentId, $entityId, $entityTable = '
    *
    * @return array
    */
-  public function mergeTags($tagAId, $tagBId) {
+  public static function mergeTags($tagAId, $tagBId) {
     $queryParams = [
       1 => [$tagAId, 'Integer'],
       2 => [$tagBId, 'Integer'],

CRM/Core/BAO/MailSettings.php

@@ -134,7 +134,7 @@ public static function retrieve(&$params, &$defaults) {
    *   Reference array contains the values submitted by the form.
    *
    *
-   * @return object
+   * @return CRM_Core_DAO_MailSettings
    */
   public static function add(&$params) {
     $result = NULL;
@@ -167,7 +167,7 @@ public static function add(&$params) {
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
    *
-   * @return CRM_Core_BAO_MailSettings
+   * @return CRM_Core_DAO_MailSettings|CRM_Core_Error
    */
   public static function create(&$params) {
     $transaction = new CRM_Core_Transaction();

CRM/Core/BAO/Navigation.php

@@ -694,7 +694,7 @@ public static function createOrUpdateTopLevelReportsNavItem($domain_id) {
    * care about output params appended.
    *
    * @param string $url
-   * @param array $url_params
+   * @param string $url_params
    *
    * @param int|null $parent_id
    *   Optionally restrict to one parent.

CRM/Core/BAO/Phone.php

@@ -205,7 +205,7 @@ public static function allEntityPhones($entityElements, $type = NULL) {
   /**
    * Set NULL to phone, mapping, uffield
    *
-   * @param $optionId
+   * @param int $optionId
    *   Value of option to be deleted.
    */
   public static function setOptionToNull($optionId) {

CRM/Core/BAO/PrevNextCache.php

@@ -287,7 +287,7 @@ public static function retrieve($cacheKey, $join = NULL, $whereClause = NULL, $o
   }
 
   /**
-   * @param $string
+   * @param mixed $string
    *
    * @return bool
    */

CRM/Core/BAO/UFGroup.php

@@ -1604,7 +1604,7 @@ public static function getUFJoinRecord($ufGroupId = NULL, $displayName = NULL, $
    * @param array $params
    *   (reference) an assoc array of name/value pairs.
    *
-   * @return CRM_Core_BAO_UFJoin
+   * @return CRM_Core_DAO_UFJoin
    */
   public static function addUFJoin(&$params) {
     $ufJoin = new CRM_Core_DAO_UFJoin();

CRM/Core/BAO/Website.php

@@ -40,8 +40,9 @@ public static function create($params) {
    *
    * @param array $params
    *
-   * @return bool|CRM_Core_BAO_Website
+   * @return CRM_Core_DAO_Website
    * @throws \CRM_Core_Exception
+   * @deprecated
    */
   public static function add($params) {
     CRM_Core_Error::deprecatedFunctionWarning('use apiv4');

CRM/Core/CodeGen/GenerateData.php

@@ -334,7 +334,7 @@ private function randomChar() {
   /**
    * Get a random item from the sample data or any other array
    *
-   * @param $items (array or string) - if string, used as key for sample data,
+   * @param array|string $items if string, used as key for sample data,
    *   if array, used as data source
    *
    * @return mixed (element from array)
@@ -908,8 +908,8 @@ private function addRelationship() {
   /**
    * Create an address for a contact
    *
-   * @param $cid int: contact id
-   * @param $masterContactId int: set if this is a shared address
+   * @param int $cid: contact id
+   * @param int $masterContactId: set if this is a shared address
    *
    * @return array
    */
@@ -960,7 +960,7 @@ private function _addAddress($cid, $masterContactId = NULL) {
   /**
    * Add a phone number for a contact
    *
-   * @param $cid int: contact id
+   * @param int $cid: contact id
    *
    * @return array
    */
@@ -982,7 +982,7 @@ private function _addPhone($cid) {
   /**
    * Add an email for a contact
    *
-   * @param $cid int: contact id
+   * @param int $cid: contact id
    * @param $email
    * @param $locationType
    *
@@ -1002,8 +1002,8 @@ private function _addEmail($cid, $email, $locationType) {
    * Add a website based on organization name
    * Using common naming patterns
    *
-   * @param $cid int: contact id
-   * @param $name str: contact name
+   * @param int $cid: contact id
+   * @param string $name: contact name
    *
    * @return array
    */
@@ -1043,8 +1043,8 @@ private function _addWebsite($cid, $name) {
    * Create an email address based on a person's name
    * Using common naming patterns
    *
-   * @param $contact obj: individual contact record
-   * @param $domain str: supply a domain (i.e. for a work address)
+   * @param CRM_Contact_DAO_Contact $contact: individual contact record
+   * @param string $domain: supply a domain (i.e. for a work address)
    *
    * @return string
    */

CRM/Core/CodeGen/Util/File.php

@@ -6,7 +6,7 @@
 class CRM_Core_CodeGen_Util_File {
 
   /**
-   * @param $dir
+   * @param string $dir
    * @param int $perm
    */
   public static function createDir($dir, $perm = 0755) {
@@ -16,7 +16,7 @@ public static function createDir($dir, $perm = 0755) {
   }
 
   /**
-   * @param $dir
+   * @param string $dir
    */
   public static function cleanTempDir($dir) {
     foreach (glob("$dir/*") as $tempFile) {
@@ -31,7 +31,7 @@ public static function cleanTempDir($dir) {
   }
 
   /**
-   * @param $prefix
+   * @param string $prefix
    *
    * @return string
    */

CRM/Core/Component/Info.php

@@ -332,7 +332,7 @@ private function _getMenuXMLPath() {
   /**
    * Helper for instantiating component's elements.
    *
-   * @param $cl
+   * @param string $cl
    *
    * @return mixed
    *   component's element as class instance

CRM/Core/Controller/Simple.php

@@ -23,7 +23,7 @@ class CRM_Core_Controller_Simple extends CRM_Core_Controller {
   /**
    * Constructor.
    *
-   * @param null $path
+   * @param string $path
    *   The class Path of the form being implemented
    * @param bool $title
    * @param string $mode

CRM/Core/DAO/permissions.php

@@ -12,9 +12,9 @@
 /**
  * Decide what permissions to check for an api call
  *
- * @param $entity : (str) api entity
- * @param $action : (str) api action
- * @param $params : (array) api params
+ * @param string $entity api entity
+ * @param string $action api action
+ * @param array $params api params
  *
  * @return array
  *   Array of permissions to check for this entity-action combo

CRM/Core/Error.php

@@ -452,7 +452,7 @@ function_exists($config->fatalErrorHandler)
    * so we can interrupt a potential POST/redirect
    *
    * @param string $name name of debug section
-   * @param $variable mixed reference to variables that we need a trace of
+   * @param mixed $variable reference to variables that we need a trace of
    * @param bool $log should we log or return the output
    * @param bool $html whether to generate a HTML-escaped output
    * @param bool $checkPermission should we check permissions before displaying output

CRM/Core/Form/Task/PDFLetterCommon.php

@@ -196,7 +196,7 @@ public static function setDefaultValues() {
    * @param array $fields
    *   The input form values.
    * @param array $files
-   * @param array $self
+   * @param self $self
    *   Additional values form 'this'.
    *
    * @return bool
@@ -325,7 +325,7 @@ public static function processTemplate(&$formValues) {
   /**
    * @deprecated
    *
-   * @param $message
+   * @param string $message
    */
   public static function formatMessage(&$message) {
     $newLineOperators = [

CRM/Core/I18n/NativeGettext.php

@@ -18,7 +18,7 @@
 class CRM_Core_I18n_NativeGettext {
 
   /**
-   * @param $string
+   * @param string $string
    *
    * @return string
    */
@@ -29,8 +29,8 @@ public function translate($string) {
   /**
    * Based on php-gettext, since native gettext does not support this as is.
    *
-   * @param $context
-   * @param $text
+   * @param string $context
+   * @param string $text
    *
    * @return string
    */
@@ -47,9 +47,9 @@ public function pgettext($context, $text) {
   }
 
   /**
-   * @param $text
-   * @param $plural
-   * @param $count
+   * @param string $text
+   * @param string $plural
+   * @param int $count
    *
    * @return string
    */

CRM/Core/I18n/Schema.php

@@ -451,8 +451,8 @@ private static function createIndexQueries($locale, $table, $class = 'CRM_Core_I
    *   schema structure class to use.
    * @param bool $isUpgradeMode
    *   Are we in upgrade mode therefore only build based off table not class
-   * @return array
-   *   array of CREATE INDEX queries
+   * @return string
+   *   The generated CREATE VIEW query
    */
   private static function createViewQuery($locale, $table, &$dao, $class = 'CRM_Core_I18n_SchemaStructure', $isUpgradeMode = FALSE) {
     $columns =& $class::columns();

CRM/Core/Menu.php

@@ -528,7 +528,7 @@ public static function fillComponentIds(&$menu, $path) {
   }
 
   /**
-   * @param $path string
+   * @param string $path
    *   Path of menu item to retrieve.
    *
    * @return array