HuasoFoundries / jpgraph

src/graph/Axis.php

Doc Comments +4 added lines

@@ -19,6 +19,10 @@
     }
 
     // Stroke the axis.
+
+    /**
+     * @param LinearScale $aOtherAxisScale
+     */
     public function Stroke($aOtherAxisScale, $aStrokeLabels = true)
     {
         if ($this->hide) {

src/graph/AxisPrototype.php

Doc Comments +10 added lines

@@ -84,6 +84,9 @@ 
         $this->scale->ticks->SetFormatCallback($aFuncName);
     }
 
+    /**
+     * @param string $aHAlign
+     */
     public function SetLabelAlign($aHAlign, $aVAlign = 'top', $aParagraphAlign = 'left')
     {
         $this->label_halign     = $aHAlign;
@@ -188,6 +191,10 @@ 
     }
 
     // Which side of the axis should the axis title be?
+
+    /**
+     * @param integer $aSideOfAxis
+     */
     public function SetTitleSide($aSideOfAxis)
     {
         $this->title_side = $aSideOfAxis;
@@ -233,6 +240,9 @@ 
         $this->label_step = $aStep;
     }
 
+    /**
+     * @param integer $aSidePos
+     */
     public function SetLabelSide($aSidePos)
     {
         $this->labelPos = $aSidePos;

src/graph/GanttActivityInfo.php

Doc Comments +3 added lines

@@ -231,6 +231,9 @@
         }
     }
 
+    /**
+     * @param \Amenadiel\JpGraph\Image\RotImage $aImg
+     */
     public function GetWidth($aImg)
     {
         $txt = new TextProperty();

src/graph/GanttScale.php

Doc Comments +35 added lines

@@ -47,6 +47,10 @@ 
 
     //---------------
     // CONSTRUCTOR
+
+    /**
+     * @param \Amenadiel\JpGraph\Image\RotImage $aImg
+     */
     public function __construct($aImg)
     {
         $this->iImg        = $aImg;
@@ -153,6 +157,10 @@ 
     // Specify the width of the titles(labels) for the activities
     // (This is by default set to the minimum width enought for the
     // widest title)
+
+    /**
+     * @param integer $aLabelWidth
+     */
     public function SetLabelWidth($aLabelWidth)
     {
         $this->iLabelWidth = $aLabelWidth;
@@ -324,6 +332,10 @@ 
     }
 
     // Get week number
+
+    /**
+     * @param integer $aDate
+     */
     public function GetWeekNbr($aDate, $aSunStart = true)
     {
         // We can't use the internal strftime() since it gets the weeknumber
@@ -377,6 +389,10 @@ 
     }
 
     // Get current year
+
+    /**
+     * @param integer $aDate
+     */
     public function GetYear($aDate)
     {
         return 0 + Date("Y", $aDate);
@@ -395,18 +411,30 @@ 
     }
 
     // Get day in month
+
+    /**
+     * @param integer $aDate
+     */
     public function GetMonthDayNbr($aDate)
     {
         return 0 + strftime("%d", $aDate);
     }
 
     // Get day in year
+
+    /**
+     * @param integer $aDate
+     */
     public function GetYearDayNbr($aDate)
     {
         return 0 + strftime("%j", $aDate);
     }
 
     // Get month number
+
+    /**
+     * @param integer $aDate
+     */
     public function GetMonthNbr($aDate)
     {
         return 0 + strftime("%m", $aDate);
@@ -495,6 +523,9 @@ 
 
     // Convert a time string to minutes
 
+    /**
+     * @param integer $aTimeString
+     */
     public function TimeToMinutes($aTimeString)
     {
         // Split in hours and minutes
@@ -995,6 +1026,10 @@ 
     }
 
     // Stroke year scale and gridlines
+
+    /**
+     * @param integer $aYCoord
+     */
     public function StrokeYears($aYCoord, $getHeight = false)
     {
         if ($this->year->iShowLabels) {

src/graph/Graph.php

Doc Comments +26 added lines

@@ -237,6 +237,9 @@ 
         $this->margin_color = [250, 250, 250];
     }
 
+    /**
+     * @param string $aFilename
+     */
     public function SetupCache($aFilename, $aTimeout = 60)
     {
         $this->cache_name = $aFilename;
@@ -284,6 +287,10 @@ 
     }
 
     // Should the grid be in front or back of the plot?
+
+    /**
+     * @param integer $aDepth
+     */
     public function SetGridDepth($aDepth)
     {
         $this->grid_depth = $aDepth;
@@ -295,6 +302,10 @@ 
     }
 
     // Specify graph angle 0-360 degrees.
+
+    /**
+     * @param integer $aAngle
+     */
     public function SetAngle($aAngle)
     {
         $this->img->SetAngle($aAngle);
@@ -775,6 +786,10 @@ 
     // Specify density of ticks when autoscaling 'normal', 'dense', 'sparse', 'verysparse'
     // The dividing factor have been determined heuristically according to my aesthetic
     // sense (or lack off) y.m.m.v !
+
+    /**
+     * @param integer $aYDensity
+     */
     public function SetTickDensity($aYDensity = TICKD_NORMAL, $aXDensity = TICKD_NORMAL)
     {
         $this->xtick_factor = 30;
@@ -875,6 +890,10 @@ 
     }
 
     // Get a complete <MAP>..</MAP> tag for the final image map
+
+    /**
+     * @param string $aMapName
+     */
     public function GetHTMLImageMap($aMapName)
     {
         $im = "<map name=\"$aMapName\" id=\"$aMapName\" >\n";
@@ -1050,6 +1069,9 @@ 
         }
     }
 
+    /**
+     * @param string $aCSIMName
+     */
     public function GetCSIMImgHTML($aCSIMName, $aScriptName = 'auto', $aBorder = 0)
     {
         if ($aScriptName == 'auto') {
@@ -1551,6 +1573,10 @@ 
         }
     }
 
+    /**
+     * @param integer $aDepth
+     * @param boolean $aCSIM
+     */
     public function StrokeBands($aDepth, $aCSIM)
     {
         // Stroke bands

src/graph/Legend.php

Doc Comments +3 added lines

@@ -217,6 +217,9 @@
         return (boolean) (count($this->txtcol));
     }
 
+    /**
+     * @param \Amenadiel\JpGraph\Image\RotImage $aImg
+     */
     public function Stroke($aImg)
     {
         // Constant

src/graph/LinearScale.php

Doc Comments +31 added lines

@@ -259,6 +259,10 @@ 
 
     // Calculate autoscale. Used if user hasn't given a scale and ticks
     // $maxsteps is the maximum number of major tickmarks allowed.
+
+    /**
+     * @param \Amenadiel\JpGraph\Image\RotImage $img
+     */
     public function AutoScale($img, $min, $max, $maxsteps, $majend = true)
     {
         if (!is_numeric($min) || !is_numeric($max)) {
@@ -422,6 +426,12 @@ 
     //  [$numsteps,$adjmin,$adjmax,$minstep,$majstep]
     // If $majend==true then the first and last marks on the axis will be major
     // labeled tick marks otherwise it will be adjusted to the closest min tick mark
+
+    /**
+     * @param double $min
+     * @param integer $a
+     * @param integer $b
+     */
     public function CalcTicks($maxsteps, $min, $max, $a, $b, $majend = true)
     {
         $diff = $max - $min;
@@ -465,6 +475,11 @@ 
         return array($numsteps, $adjmin, $adjmax, $minstep, $majstep);
     }
 
+    /**
+     * @param double $min
+     * @param integer $a
+     * @param integer $b
+     */
     public function CalcTicksFreeze($maxsteps, $min, $max, $a, $b)
     {
         // Same as CalcTicks but don't adjust min/max values
@@ -489,6 +504,12 @@ 
         return array($numsteps, $minstep, $majstep);
     }
 
+    /**
+     * @param double $maxsteps
+     * @param double $min
+     * @param double $max
+     * @param integer $a
+     */
     public function IntCalcTicks($maxsteps, $min, $max, $a, $majend = true)
     {
         $diff = $max - $min;
@@ -534,6 +555,12 @@ 
         return array($numsteps, $adjmin, $adjmax, $majstep);
     }
 
+    /**
+     * @param double $maxsteps
+     * @param double $min
+     * @param double $max
+     * @param integer $a
+     */
     public function IntCalcTicksFreeze($maxsteps, $min, $max, $a)
     {
         // Same as IntCalcTick but don't change min/max values
@@ -563,6 +590,10 @@ 
     }
 
     // Determine the minimum of three values witha  weight for last value
+
+    /**
+     * @param double $weight
+     */
     public function MatchMin3($a, $b, $c, $weight)
     {
         if ($a < $b) {

src/graph/LogTicks.php

Doc Comments +3 added lines

@@ -25,6 +25,9 @@
         return true;
     }
 
+    /**
+     * @param integer $aType
+     */
     public function SetLabelLogType($aType)
     {
         $this->label_logtype = $aType;

src/graph/MGraph.php

Doc Comments +7 added lines

@@ -200,6 +200,10 @@ 
         $this->_gdImgHandle($aGraph->Stroke(_IMG_HANDLER), $x, $y, $fx = 0, $fy = 0, $w, $h);
     }
 
+    /**
+     * @param integer $x
+     * @param integer $y
+     */
     public function _gdImgHandle($agdCanvas, $x, $y, $fx = 0, $fy = 0, $w = 0, $h = 0, $mix = 100)
     {
         if ($w == 0) {
@@ -245,6 +249,9 @@ 
         $this->footer->iRightMargin += $aShadowWidth;
     }
 
+    /**
+     * @param Image\Image $image
+     */
     public function StrokeTitle($image, $w, $h)
     {
         // Stroke title