Cleanup phpdoc comments

[civicrm-core.git] / CRM / SMS / Provider.php

diff --git a/CRM/SMS/Provider.php b/CRM/SMS/Provider.php
index 5431f32a615eb621ed49e9ef2782a46f3aebdeaf..5fa2f04788708337437104df8b07115c5cbaa09b 100644 (file)
--- a/CRM/SMS/Provider.php
+++ b/CRM/SMS/Provider.php
@@ -46,7 +46,7 @@ abstract class CRM_SMS_Provider {
   CONST MAX_SMS_CHAR = 460;
 
   /**
-   * singleton function used to manage this object
+   * Singleton function used to manage this object
    *
    * @param array $providerParams
    * @param bool $force
@@ -54,8 +54,7 @@ abstract class CRM_SMS_Provider {
    * @return object
    * @static
    */
-  static function &singleton($providerParams = array(
-    ), $force = FALSE) {
+  static function &singleton($providerParams = array(), $force = FALSE) {
     $mailingID    = CRM_Utils_Array::value('mailing_id', $providerParams);
     $providerID   = CRM_Utils_Array::value('provider_id', $providerParams);
     $providerName = CRM_Utils_Array::value('provider', $providerParams);
@@ -97,7 +96,7 @@ abstract class CRM_SMS_Provider {
   abstract function send($recipients, $header, $message, $dncID = NULL);
 
   /**
-   * Function to return message text. Child class could override this function to have better control over the message being sent.
+   * Return message text. Child class could override this function to have better control over the message being sent.
    *
    * @access public
    */
@@ -121,17 +120,16 @@ abstract class CRM_SMS_Provider {
   }
 
   /**
-   * @param $apiMsgID
+   * @param int $apiMsgID
    * @param $message
    * @param array $headers
-   * @param null $jobID
-   * @param null $userID
+   * @param int $jobID
+   * @param int $userID
    *
    * @return $this|null|object
    * @throws CRM_Core_Exception
    */
-  function createActivity($apiMsgID, $message, $headers = array(
-    ), $jobID = NULL, $userID = NULL) {
+  function createActivity($apiMsgID, $message, $headers = array(), $jobID = NULL, $userID = NULL) {
     if ($jobID) {
       $sql = "
 SELECT scheduled_id FROM civicrm_mailing m
@@ -167,7 +165,7 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
   }
 
   /**
-   * @param $name
+   * @param string $name
    * @param $type
    * @param bool $abort
    * @param null $default
@@ -192,7 +190,7 @@ INNER JOIN civicrm_mailing_job mj ON mj.mailing_id = m.id AND mj.id = %1";
    * @param $from
    * @param $body
    * @param null $to
-   * @param null $trackID
+   * @param int $trackID
    *
    * @return $this|null|object
    * @throws CRM_Core_Exception