adamjakab / SuiteCRM

modules/AOD_Index/Lib/Zend/Search/Lucene/Search/Similarity.php

Doc Comments +3 added lines, -3 removed lines

@@ -407,8 +407,8 @@ 
     /**
      * Float to byte conversion
      *
-     * @param integer $b
-     * @return float
+     * @param double $f
+     * @return integer
      */
     private static function _floatToByte($f)
     {
@@ -494,7 +494,7 @@ 
      *
      * @param mixed $input
      * @param Zend_Search_Lucene_Interface $reader
-     * @return a score factor for the term
+     * @return double score factor for the term
      */
     public function idf($input, Zend_Search_Lucene_Interface $reader)
     {

modules/AOD_Index/Lib/Zend/Search/Lucene/Storage/Directory/Filesystem.php

Doc Comments +1 added lines, -1 removed lines

@@ -322,7 +322,7 @@
      * Sets the modified time of $filename to now.
      *
      * @param string $filename
-     * @return void
+     * @return boolean
      */
     public function touchFile($filename)
     {

modules/AOD_Index/PdfParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
   /**
    * Convert a PDF into text.
    *
-   * @param string $filename The filename to extract the data from.
+   * @param string $data
    * @return string The extracted text from the PDF
    */
   protected static function extractText($data)

modules/AOP_Case_Events/CaseEventsHook.php

Doc Comments +3 added lines

@@ -31,6 +31,9 @@
         array('field'=> 'type', 'display_field' => 'type', 'display_name' => 'Type'),
     );
 
+    /**
+     * @param aCase $old
+     */
     private function compareBeans($old, $new){
         $events = array();
         foreach($this->diff_fields as $field){

modules/AOP_Case_Updates/CaseUpdatesHook.php

Doc Comments +3 added lines

@@ -443,6 +443,9 @@
         }
     }
 
+    /**
+     * @param SugarPHPMailer $mailer
+     */
     private function logEmail($email, $mailer, $caseId = null){
         require_once('modules/Emails/Email.php');
         $emailObj = new Email();

modules/AOP_Case_Updates/util.php

Doc Comments +1 added lines

@@ -93,6 +93,7 @@
 
 /**
  * Custom parse template method since sugars own doesn't deal with custom fields.
+ * @param string $string
  */
 function aop_parse_template($string, &$bean_arr) {
     global $beanFiles, $beanList;

modules/AOR_Charts/AOR_Chart.php

Doc Comments +73 added lines

@@ -56,6 +56,9 @@ 
 		parent::Basic();
 	}
 
+    /**
+     * @param string $postKey
+     */
     function save_lines(array $post,AOR_Report $bean,$postKey){
         $seenIds = array();
         if(isset($post[$postKey.'id'])) {
@@ -105,12 +108,23 @@ 
         return array('main'=>$main,'highlight'=>$highlight);
     }
 
+    /**
+     * @param pImage $chartPicture
+     */
     function buildChartImageBar($chartPicture,$recordImageMap = false){
         $scaleSettings = array("DrawSubTicks" => false, "LabelRotation" => 30, 'MinDivHeight' => 50);
         $chartPicture->drawScale($scaleSettings);
         $chartPicture->drawBarChart(array("RecordImageMap"=>$recordImageMap));
     }
 
+    /**
+     * @param pImage $chartPicture
+     * @param pData $chartData
+     * @param integer $imageHeight
+     * @param integer $imageWidth
+     * @param string $xName
+     * @param boolean $recordImageMap
+     */
     function buildChartImagePie($chartPicture,$chartData, $reportData,$imageHeight, $imageWidth, $xName,$recordImageMap){
         $PieChart = new pPie($chartPicture,$chartData);
         $x = 0;
@@ -122,12 +136,20 @@ 
         $PieChart->drawPieLegend($imageWidth*0.7,$imageHeight/3, array('FontSize'=>10,"FontName"=>"modules/AOR_Charts/lib/pChart/fonts/verdana.ttf",'BoxSize'=>14));
     }
 
+    /**
+     * @param pImage $chartPicture
+     */
     function buildChartImageLine($chartPicture, $recordImageMap = false){
         $scaleSettings = array("XMargin"=>10,"YMargin"=>10,"GridR"=>200,"GridG"=>200,"GridB"=>200,'MinDivHeight' => 50,"LabelRotation" => 30);
         $chartPicture->drawScale($scaleSettings);
         $chartPicture->drawLineChart(array("RecordImageMap"=>$recordImageMap));
     }
 
+    /**
+     * @param pImage $chartPicture
+     * @param pData $chartData
+     * @param boolean $recordImageMap
+     */
     function buildChartImageRadar($chartPicture, $chartData,$recordImageMap){
         $SplitChart = new pRadar();
         $Options = array("LabelPos"=>RADAR_LABELS_HORIZONTAL,"RecordImageMap"=>$recordImageMap);
@@ -303,6 +325,11 @@ 
         return $chart;
     }
 
+    /**
+     * @param string $chartDataValues
+     * @param string $chartLabelValues
+     * @param string $chartTooltips
+     */
     private function getRGraphRoseChart($chartDataValues, $chartLabelValues,$chartTooltips, $chartName= '', $chartId, $chartHeight = 400, $chartWidth = 400)
     {
         $dataArray = json_decode($chartDataValues);
@@ -340,6 +367,12 @@ 
     //I have not used a parameter for getRGraphBarChart to say whether to group etc, as the future development could be quite different
     //for both, hence the separate methods.  However, the $grouped parameter allows us to specify whether the chart is grouped (true)
     //or stacked (false)
+
+    /**
+     * @param string $chartDataValues
+     * @param string $chartLabelValues
+     * @param string $chartTooltips
+     */
     private function getRGraphGroupedBarChart($chartDataValues, $chartLabelValues,$chartTooltips, $chartName= '', $chartId, $chartHeight = 400, $chartWidth = 400, $grouped = false)
     {
         //$keys = array_keys($chartTooltips);
@@ -398,6 +431,11 @@ 
 
 
 
+    /**
+     * @param string $chartDataValues
+     * @param string $chartLabelValues
+     * @param string $chartTooltips
+     */
     private function getRGraphBarChart($chartDataValues, $chartLabelValues,$chartTooltips, $chartName= '', $chartId, $chartHeight = 400, $chartWidth = 400)
     {
         $dataArray = json_decode($chartDataValues);
@@ -437,6 +475,11 @@ 
         return $html;
     }
 
+    /**
+     * @param string $chartDataValues
+     * @param string $chartLabelValues
+     * @param string $chartTooltips
+     */
     private function getRGraphRadarChart($chartDataValues, $chartLabelValues,$chartTooltips, $chartName= '', $chartId, $chartHeight = 400, $chartWidth = 400)
     {
         $dataArray = json_decode($chartDataValues);
@@ -469,6 +512,11 @@ 
         return $html;
     }
 
+    /**
+     * @param string $chartDataValues
+     * @param string $chartLabelValues
+     * @param string $chartTooltips
+     */
     private function getRGraphPieChart($chartDataValues, $chartLabelValues,$chartTooltips, $chartName= '', $chartId, $chartHeight = 400, $chartWidth = 400)
     {
         $dataArray = json_decode($chartDataValues);
@@ -505,6 +553,11 @@ 
         return $html;
     }
 
+    /**
+     * @param string $chartDataValues
+     * @param string $chartLabelValues
+     * @param string $chartTooltips
+     */
     private function getRGraphLineChart($chartDataValues, $chartLabelValues,$chartTooltips, $chartName= '', $chartId, $chartHeight = 400, $chartWidth = 400)
     {
         $dataArray = json_decode($chartDataValues);
@@ -637,6 +690,10 @@ 
     }
 
 
+    /**
+     * @param string $xName
+     * @param string $yName
+     */
     private function getRGraphGroupedBarChartData($reportData, $xName,$yName, AOR_Field $mainGroupField){
 
 
@@ -706,6 +763,10 @@ 
 
     }
 
+    /**
+     * @param string $xName
+     * @param string $yName
+     */
     private function getRGraphBarChartData($reportData, $xName,$yName){
         $chart['labels']=array();
         $chart['data']=array();
@@ -753,6 +814,10 @@ 
         return '';
     }
 
+    /**
+     * @param string $xName
+     * @param string $yName
+     */
     private function getLineChartData($reportData, $xName,$yName){
         return $this->getBarChartData($reportData, $xName,$yName);
     }
@@ -778,10 +843,18 @@ 
         return $this->getBarChartConfig();
     }
 
+    /**
+     * @param string $xName
+     * @param string $yName
+     */
     private function getRadarChartData($reportData, $xName,$yName){
         return $this->getBarChartData($reportData, $xName,$yName);
     }
 
+    /**
+     * @param string $xName
+     * @param string $yName
+     */
     private function getPolarChartData($reportData, $xName,$yName){
         return $this->getPieChartData($reportData, $xName,$yName);
     }

modules/AOR_Charts/lib/pChart/class/pBarcode128.class.php

Doc Comments +4 added lines

@@ -179,6 +179,10 @@
 
    function left($value,$NbChar) { return substr($value,0,$NbChar); }  
    function right($value,$NbChar) { return substr($value,strlen($value)-$NbChar,$NbChar); }  
+
+   /**
+    * @param integer $NbChar
+    */
    function mid($value,$Depart,$NbChar) { return substr($value,$Depart-1,$NbChar); }  
   }
 ?>
\ No newline at end of file

modules/AOR_Charts/lib/pChart/class/pBarcode39.class.php

Doc Comments +8 added lines

@@ -181,6 +181,9 @@ 
       }
     }
 
+   /**
+    * @param string $string
+    */
    function checksum( $string )
     {
      $checksum = 0;
@@ -195,6 +198,11 @@ 
 
    function left($value,$NbChar) { return substr($value,0,$NbChar); }  
    function right($value,$NbChar) { return substr($value,strlen($value)-$NbChar,$NbChar); }  
+
+   /**
+    * @param integer $Depart
+    * @param integer $NbChar
+    */
    function mid($value,$Depart,$NbChar) { return substr($value,$Depart-1,$NbChar); }  
   }
 ?>
\ No newline at end of file