HuasoFoundries / jpgraph

src/image/ImgStreamCache.php

Doc Comments +19 added lines

@@ -26,12 +26,22 @@ 
     // timeout value it will be overwritten with a newer version.
     // If timeout is set to 0 this is the same as infinite large timeout and if
     // timeout is set to -1 this is the same as infinite small timeout
+
+    /**
+     * @param integer $aTimeout
+     */
     public function SetTimeout($aTimeout)
     {
         $this->timeout = $aTimeout;
     }
 
     // Output image to browser and also write it to the cache
+
+    /**
+     * @param Image $aImage
+     * @param boolean $aInline
+     * @param string $aStrokeFileName
+     */
     public function PutAndStream($aImage, $aCacheFileName, $aInline, $aStrokeFileName)
     {
 
@@ -169,6 +179,11 @@ 
     // Check if a given image is in cache and in that case
     // pass it directly on to web browser. Return false if the
     // image file doesn't exist or exists but is to old
+
+    /**
+     * @param Image $aImage
+     * @param string $aCacheFileName
+     */
     public function GetAndStream($aImage, $aCacheFileName)
     {
         if ($this->Isvalid($aCacheFileName)) {
@@ -181,6 +196,10 @@ 
     //---------------
     // PRIVATE METHODS
     // Create all necessary directories in a path
+
+    /**
+     * @param string $aFile
+     */
     public function MakeDirs($aFile)
     {
         $dirs = array();

src/image/ImgTrans.php

Doc Comments +4 added lines

@@ -220,6 +220,10 @@
     // * $aBorder, if set to anything besides false this will draw a
     //   a border of the speciied color around the image
     // --------------------------------------------------------------------
+
+    /**
+     * @param integer $aDir
+     */
     public function Skew3D($aHorizon = 120, $aSkewDist = 150, $aDir = SKEW3D_DOWN, $aHiQuality = false, $aMinSize = true, $aFillColor = '#FFFFFF', $aBorder = false)
     {
         return $this->_Skew3D($this->gdImg, $aHorizon, $aSkewDist, $aDir, $aHiQuality,

src/plot/Contour.php

Doc Comments +10 added lines, -10 removed lines

@@ -136,10 +136,10 @@ 
     /**
      * Determine if the specified isobar crosses the horizontal edge specified by its row and column
      *
-     * @param $aRow Row index of edge to be checked
-     * @param $aCol Col index of edge to be checked
+     * @param integer $aRow Row index of edge to be checked
+     * @param integer $aCol Col index of edge to be checked
      * @param $aIsobar Isobar value
-     * @return true if the isobar is crossing this edge
+     * @return boolean if the isobar is crossing this edge
      */
     public function isobarHCrossing($aRow, $aCol, $aIsobar)
     {
@@ -161,10 +161,10 @@ 
     /**
      * Determine if the specified isobar crosses the vertical edge specified by its row and column
      *
-     * @param $aRow Row index of edge to be checked
-     * @param $aCol Col index of edge to be checked
+     * @param integer $aRow Row index of edge to be checked
+     * @param integer $aCol Col index of edge to be checked
      * @param $aIsobar Isobar value
-     * @return true if the isobar is crossing this edge
+     * @return boolean if the isobar is crossing this edge
      */
     public function isobarVCrossing($aRow, $aCol, $aIsobar)
     {
@@ -187,7 +187,7 @@ 
      * Determine all edges, horizontal and vertical that the specified isobar crosses. The crossings
      * are recorded in the two edge matrices.
      *
-     * @param $aIsobar The value of the isobar to be checked
+     * @param integer $aIsobar The value of the isobar to be checked
      */
     public function determineIsobarEdgeCrossings($aIsobar)
     {
@@ -214,9 +214,9 @@ 
      * isobar- The crossing is simpy detrmined with a linear interpolation between the two vertices
      * on each side of the edge and the value of the isobar
      *
-     * @param $aRow Row of edge
-     * @param $aCol Column of edge
-     * @param $aEdgeDir Determine if this is a horizontal or vertical edge
+     * @param integer $aRow Row of edge
+     * @param integer $aCol Column of edge
+     * @param integer $aEdgeDir Determine if this is a horizontal or vertical edge
      * @param $ib The isobar value
      * @return unknown_type
      */

src/plot/Gradient.php

Doc Comments +8 added lines

@@ -28,6 +28,9 @@ 
         $this->img = $img;
     }
 
+    /**
+     * @param integer $aNum
+     */
     public function SetNumColors($aNum)
     {
         $this->numcolors = $aNum;
@@ -328,6 +331,11 @@ 
     // Please note that this is NOT a generic gradient polygon fill
     // routine. It assumes that the bottom is flat (like a drawing
     // of a mountain)
+
+    /**
+     * @param string $from_color
+     * @param string $to_color
+     */
     public function FilledFlatPolygon($pts, $from_color, $to_color)
     {
         if (count($pts) == 0) {

src/plot/IconPlot.php

Doc Comments +4 added lines

@@ -167,6 +167,10 @@
         return $this->_Stroke($dummy, null, null, true);
     }
 
+    /**
+     * @param double $x
+     * @param double $y
+     */
     public function _Stroke($aImg, $x = null, $y = null, $aReturnWidthHeight = false)
     {
         if ($this->iFile != '' && $this->iCountryFlag != '') {

src/plot/PiePlot.php

Doc Comments +8 added lines

@@ -144,6 +144,11 @@ 
         return $this->csimareas;
     }
 
+    /**
+     * @param integer $i
+     * @param double $xc
+     * @param double $yc
+     */
     public function AddSliceToCSIM($i, $xc, $yc, $radius, $sa, $ea)
     {
         //Slice number, ellipse centre (x,y), height, width, start angle, end angle
@@ -1007,6 +1012,9 @@ 
         }
     }
 
+    /**
+     * @param double $yc
+     */
     public function StrokeAllLabels($img, $xc, $yc, $radius)
     {
         // First normalize all angles for labels

src/plot/PiePlot3D.php

Doc Comments +33 added lines

@@ -87,6 +87,15 @@ 
         }
     }
 
+    /**
+     * @param integer $i
+     * @param double $xc
+     * @param double $yc
+     * @param double $height
+     * @param double $width
+     * @param double $sa
+     * @param double $ea
+     */
     public function Add3DSliceToCSIM($i, $xc, $yc, $height, $width, $thick, $sa, $ea)
     {
         //Slice number, ellipse centre (x,y), height, width, start angle, end angle
@@ -201,6 +210,10 @@ 
     }
 
     // Draw one 3D pie slice at position ($xc,$yc) with height $z
+
+    /**
+     * @param double $h
+     */
     public function Pie3DSlice($img, $xc, $yc, $w, $h, $sa, $ea, $z, $fillcolor, $shadow = 0.65)
     {
 
@@ -413,6 +426,13 @@ 
     }
 
     // Draw a 3D Pie
+
+    /**
+     * @param integer $aaoption
+     * @param double $yc
+     * @param integer $angle
+     * @param double $z
+     */
     public function Pie3D($aaoption, $img, $data, $colors, $xc, $yc, $d, $angle, $z,
         $shadow = 0.65, $startangle = 0, $edgecolor = "", $edgeweight = 1)
     {
@@ -746,6 +766,13 @@ 
         $img->PopColor();
     }
 
+    /**
+     * @param double $sa
+     * @param double $ea
+     * @param double $h
+     * @param string $edgecolor
+     * @param boolean $fulledge
+     */
     public function StrokeFullSliceFrame($img, $xc, $yc, $sa, $ea, $w, $h, $z, $edgecolor, $exploderadius, $fulledge)
     {
         $step = 0.02;
@@ -905,6 +932,12 @@ 
     // PRIVATE METHODS
 
     // Position the labels of each slice
+
+    /**
+     * @param double $a
+     * @param double $xp
+     * @param double $yp
+     */
     public function StrokeLabels($label, $img, $a, $xp, $yp, $z)
     {
         $this->value->halign = "left";

src/plot/PiePlotC.php

Doc Comments +5 added lines

@@ -186,6 +186,11 @@
         }
     }
 
+    /**
+     * @param double $xc
+     * @param double $yc
+     * @param double $r
+     */
     public function AddMiddleCSIM($xc, $yc, $r)
     {
         $xc = round($xc);

src/plot/Plot.php

Doc Comments +3 added lines

@@ -188,6 +188,9 @@
         $this->legendcsimalt       = $aCSIMAlt;
     }
 
+    /**
+     * @param integer $aWeight
+     */
     public function SetWeight($aWeight)
     {
         $this->weight = $aWeight;