adamjakab / SuiteCRM

modules/EmailTemplates/EmailTemplate.php

Doc Comments +1 added lines, -3 removed lines

@@ -118,8 +118,6 @@ 
 
     /**
      * Generates the extended field_defs for creating macros
-     * @param object $bean SugarBean
-     * @param string $prefix "contact_", "user_" etc.
      * @return
      */
     function generateFieldDefsJS()
@@ -366,7 +364,7 @@ 
     /**
      *
      * Method for replace "preg_match_all" in method "parse_tracker_urls"
-     * @param $text string String in which we need to search all string that match the pattern {.}
+     * @param string $text string String in which we need to search all string that match the pattern {.}
      * @return array result of search
      */
     private function _preg_match_tracker_url($text)

modules/Employees/views/view.list.php

Doc Comments +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
     * Return the "breadcrumbs" to display at the top of the page
     *
     * @param  bool $show_help optional, true if we show the help links
-    * @return HTML string containing breadcrumb title
+    * @return string string containing breadcrumb title
     */
     public function getModuleTitle($show_help = true)
     {

modules/FP_events/controller.php

Doc Comments +6 added lines

@@ -598,6 +598,12 @@
     }
 
     //handles sending the emails
+
+    /**
+     * @param string $emailToname
+     * @param string $emailBody
+     * @param string $altemailBody
+     */
     public function sendEmail($emailTo, $emailSubject, $emailToname, $emailBody, $altemailBody, SugarBean $relatedBean = null, $attachments = array()){
        
         $emailObj = new Email();

modules/Home/Dashlets/RSSDashlet/RSSDashlet.php

Doc Comments +3 added lines

@@ -142,6 +142,9 @@
         return $options;
     }
 
+    /**
+     * @param string $url
+     */
     protected function getRSSOutput(
         $url
         )

modules/Home/QuickSearch.php

Doc Comments +3 added lines, -4 removed lines

@@ -78,7 +78,7 @@ 
      *        'order' => 'name', // order by
      *        'limit' => '30', // limit, number of records to return
      *       )
-     * @return array list of elements returned
+     * @return string list of elements returned
      */
     public function query($args)
     {
@@ -107,7 +107,7 @@ 
      * Returns the list of users, faster than using query method for Users module
      *
      * @param array $args arguments used to construct query, see query() for example
-     * @return array list of users returned
+     * @return string list of users returned
      */
     public function get_user_array($args)
     {
@@ -122,7 +122,7 @@ 
      * Returns search results from external API
      *
      * @param array $args
-     * @return array
+     * @return string
      */
     public function externalApi($args)
     {
@@ -496,7 +496,6 @@ 
     /**
      * Returns prepared arguments. Should be redefined in child classes.
      *
-     * @param array $arguments
      * @return array
      */
     protected function prepareArguments($args)

modules/Home/UnifiedSearch.php

Doc Comments +6 added lines

@@ -188,6 +188,9 @@ 
     $output = preg_replace(array('/(?<=[^A-Z])([A-Z])/', '/(?<=[^0-9])([0-9])/'), $sep.'$0', $input);
     return ucwords($output);
 }
+/**
+ * @param string $module
+ */
 function getModuleLabel($module){
     return translate('LBL_MODULE_NAME', $module);
 }
@@ -197,6 +200,9 @@ 
     sugar_file_put_contents_atomic($file, $out);
 }
 
+/**
+ * @param string $filePath
+ */
 function getCorrectMTime($filePath){
     $time = filemtime($filePath);
     $isDST = (date('I', $time) == 1);

modules/iCals/HTTP_WebDAV_Server_iCal.php

Doc Comments +1 added lines

@@ -156,6 +156,7 @@
          * set HTTP return status and mirror it in a private header
          *
          * @param  string  status code and message
+         * @param string $status
          * @return void
          */
         public function http_status($status)

modules/iCals/iCal.php

Doc Comments +1 added lines, -1 removed lines

@@ -191,7 +191,7 @@
     * Creates the string for the user's events and todos between the given start
     * and end times
     *
-    * @param UserBean $user_bean the current UserBean
+    * @param User $user_bean the current UserBean
     * @param DateTime $start_date_time the start date to search from
     * @param DateTime $end_date_time the end date to search to
     * @param string $dtstamp the current timestamp

modules/Import/ImportDuplicateCheck.php

Doc Comments -1 removed lines

@@ -133,7 +133,6 @@
     /**
      * Checks to see if the given bean is a duplicate based off the given fields
      *
-     * @param  array $indexlist
      * @return bool true if this bean is a duplicate or false if it isn't
      */
     public function isADuplicateRecordByFields($fieldList)