XoopsModules25x / xhelp

include/jpgraph/jpgraph_errhandler.inc.php

Doc Comments +18 added lines

@@ -110,6 +110,10 @@ 
         GLOBAL $__jpg_err_locale ;
         $__jpg_err_locale = $aLoc;
     }
+
+    /**
+     * @param integer $errnbr
+     */
     public static function RaiseL($errnbr,$a1=null,$a2=null,$a3=null,$a4=null,$a5=null) {
         throw new JpGraphExceptionL($errnbr,$a1,$a2,$a3,$a4,$a5);
     }
@@ -125,6 +129,10 @@ 
     public static function GetLogFile() {
         return self::$__iLogFile;
     }
+
+    /**
+     * @param string $aTitle
+     */
     public static function SetTitle($aTitle) {
         self::$__iTitle = $aTitle;
     }
@@ -201,15 +209,25 @@ 
         // Empty. Reserved for future use
     }
 
+    /**
+     * @param string $aTitle
+     */
     function SetTitle($aTitle) {
         $this->iTitle = $aTitle;
     }
 
+    /**
+     * @param string $aDest
+     */
     function SetStrokeDest($aDest) {
         $this->iDest = $aDest;
     }
 
     // If aHalt is true then execution can't continue. Typical used for fatal errors
+
+    /**
+     * @param string $aMsg
+     */
     function Raise($aMsg,$aHalt=false) {
         if( $this->iDest != '' ) {
             if( $this->iDest == 'syslog' ) {

include/jpgraph/jpgraph_flags.php

Doc Comments +7 added lines

@@ -288,6 +288,10 @@ 
         return $this->iFlagCount;
     }
 
+    /**
+     * @param string $aName
+     * @param string $outFullName
+     */
     function GetImgByName($aName,&$outFullName) {
         $idx = $this->GetIdxByName($aName,$outFullName);
 
@@ -306,6 +310,9 @@ 
         }
     }
 
+    /**
+     * @param integer $aOrd
+     */
     function GetIdxByOrdinal($aOrd,&$outFullName) {
         $aOrd--;
         $n = count($this->iOrdIdx);

include/jpgraph/jpgraph_gantt.php

Doc Comments +106 added lines

@@ -124,6 +124,10 @@ 
 
 // Check if array_fill() exists
 if (!function_exists('array_fill')) {
+
+    /**
+     * @param integer $iStart
+     */
     function array_fill($iStart, $iLen, $vValue) {
         $aResult = array();
         for ($iCount = $iStart; $iCount < $iLen + $iStart; $iCount++) {
@@ -210,6 +214,9 @@ 
         }
     }
 
+    /**
+     * @param RotImage $aImg
+     */
     function GetWidth($aImg) {
         $txt = new TextProperty();
         $txt->SetFont($this->iFFamily,$this->iFStyle,$this->iFSize);
@@ -1587,6 +1594,10 @@ 
     }
 
     // Set text color
+
+    /**
+     * @param string $aColor
+     */
     function SetColor($aColor) {
         $this->iColor = $aColor;
     }
@@ -1611,12 +1622,20 @@ 
     }
 
     // Set alignment
+
+    /**
+     * @param string $aHAlign
+     */
     function Align($aHAlign,$aVAlign="bottom") {
         $this->iHAlign=$aHAlign;
         $this->iVAlign=$aVAlign;
     }
 
     // Synonym
+
+    /**
+     * @param string $aHAlign
+     */
     function SetAlign($aHAlign,$aVAlign="bottom") {
         $this->iHAlign=$aHAlign;
         $this->iVAlign=$aVAlign;
@@ -1859,6 +1878,9 @@ 
         $this->iShowLabels = $aShow;
     }
 
+    /**
+     * @param integer $aInt
+     */
     function SetIntervall($aInt) {
         $this->iIntervall = $aInt;
     }
@@ -1871,6 +1893,10 @@ 
         return $this->iIntervall ;
     }
 
+    /**
+     * @param integer $aFFamily
+     * @param integer $aFStyle
+     */
     function SetFont($aFFamily,$aFStyle=FS_NORMAL,$aFSize=10) {
         $this->iFFamily = $aFFamily;
         $this->iFStyle  = $aFStyle;
@@ -1887,18 +1913,28 @@ 
         return $aImg->GetFontHeight();
     }
 
+    /**
+     * @param RotImage $aImg
+     */
     function GetFontWidth($aImg) {
         $aImg->SetFont($this->iFFamily,$this->iFStyle,$this->iFSize);
 
         return $aImg->GetFontWidth();
     }
 
+    /**
+     * @param RotImage $aImg
+     * @param string $aStr
+     */
     function GetStrWidth($aImg,$aStr) {
         $aImg->SetFont($this->iFFamily,$this->iFStyle,$this->iFSize);
 
         return $aImg->GetTextWidth($aStr);
     }
 
+    /**
+     * @param integer $aStyle
+     */
     function SetStyle($aStyle) {
         $this->iStyle = $aStyle;
     }
@@ -1971,6 +2007,10 @@ 
 
     //---------------
     // CONSTRUCTOR
+
+    /**
+     * @param RotImage $aImg
+     */
     function __construct($aImg) {
         $this->iImg = $aImg;
         $this->iDateLocale = new DateLocale();
@@ -2070,6 +2110,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
+     */
     function SetLabelWidth($aLabelWidth) {
         $this->iLabelWidth=$aLabelWidth;
     }
@@ -2223,6 +2267,10 @@ 
     }
 
     // Get week number
+
+    /**
+     * @param integer $aDate
+     */
     function GetWeekNbr($aDate,$aSunStart=true) {
         // We can't use the internal strftime() since it gets the weeknumber
         // wrong since it doesn't follow ISO on all systems since this is
@@ -2271,6 +2319,10 @@ 
     }
 
     // Get current year
+
+    /**
+     * @param integer $aDate
+     */
     function GetYear($aDate) {
         return 0+Date("Y",$aDate);
     }
@@ -2286,16 +2338,28 @@ 
     }
 
     // Get day in month
+
+    /**
+     * @param integer $aDate
+     */
     function GetMonthDayNbr($aDate) {
         return 0+strftime("%d",$aDate);
     }
 
     // Get day in year
+
+    /**
+     * @param integer $aDate
+     */
     function GetYearDayNbr($aDate) {
         return 0+strftime("%j",$aDate);
     }
 
     // Get month number
+
+    /**
+     * @param integer $aDate
+     */
     function GetMonthNbr($aDate) {
         return 0+strftime("%m",$aDate);
     }
@@ -2374,6 +2438,9 @@ 
 
     // Convert a time string to minutes
 
+    /**
+     * @param integer $aTimeString
+     */
     function TimeToMinutes($aTimeString) {
         // Split in hours and minutes
         $pos=strpos($aTimeString,':');
@@ -2877,6 +2944,10 @@ 
     }
 
     // Stroke year scale and gridlines
+
+    /**
+     * @param integer $aYCoord
+     */
     function StrokeYears($aYCoord,$getHeight=false) {
         if( $this->year->iShowLabels ) {
             $img=$this->iImg;
@@ -3046,6 +3117,10 @@ 
 
     //---------------
     // CONSTRUCTOR
+
+    /**
+     * @param string $aColor
+     */
     function __construct($aRow,$aType,$aColor,$aArrowSize,$aArrowType){
         $this->iConstrainType = $aType;
         $this->iConstrainRow = $aRow;
@@ -3105,10 +3180,18 @@ 
         $this->csimalt=$aAlt;
     }
 
+    /**
+     * @param integer $aArrowSize
+     * @param integer $aArrowType
+     */
     function SetConstrain($aRow,$aType,$aColor='black',$aArrowSize=ARROW_S2,$aArrowType=ARROWT_SOLID) {
         $this->constraints[] = new GanttConstraint($aRow, $aType, $aColor, $aArrowSize, $aArrowType);
     }
 
+    /**
+     * @param double $yt
+     * @param double $yb
+     */
     function SetConstrainPos($xt,$yt,$xb,$yb) {
         $this->iConstrainPos = array($xt,$yt,$xb,$yb);
     }
@@ -3169,6 +3252,9 @@ 
         $this->iDensity = $aDensity;
     }
 
+    /**
+     * @param string $aColor
+     */
     function SetFillColor($aColor) {
         $this->iFillColor = $aColor;
     }
@@ -3211,6 +3297,10 @@ 
         $this->iStart = $aStart;
     }
 
+    /**
+     * @param RotImage $aImg
+     * @param GanttScale $aScale
+     */
     function Stroke($aImg,$aScale) {
 
         if( ! $this->iShow ) return;
@@ -3328,6 +3418,9 @@ 
         $this->iFrameColor = $aColor;
     }
 
+    /**
+     * @param string $aColor
+     */
     function SetFillColor($aColor) {
         $this->iFillColor = $aColor;
     }
@@ -3718,6 +3811,10 @@ 
     private $iDirection=ARROW_DOWN,$iType=ARROWT_SOLID,$iSize=ARROW_S2;
     private $iColor='black';
 
+    /**
+     * @param integer $x
+     * @param integer $aDirection
+     */
     function __construct($x,$y,$aDirection,$aType=ARROWT_SOLID,$aSize=ARROW_S2) {
         $this->iDirection = $aDirection;
         $this->iType = $aType;
@@ -3726,6 +3823,9 @@ 
         $this->iy = $y;
     }
 
+    /**
+     * @param string $aColor
+     */
     function SetColor($aColor) {
         $this->iColor = $aColor;
     }
@@ -3803,6 +3903,9 @@ 
         $this->iy2 = $y2;
     }
 
+    /**
+     * @param integer $aPath
+     */
     function SetPath($aPath) {
         $this->iPathType = $aPath;
     }
@@ -3820,6 +3923,9 @@ 
         $this->iWeight = $aWeight;
     }
 
+    /**
+     * @param RotImage $aImg
+     */
     function Stroke($aImg) {
         // The way the path for the arrow is constructed is partly based
         // on some heuristics. This is not an exact science but draws the

include/jpgraph/jpgraph_gradient.php

Doc Comments +8 added lines

@@ -36,6 +36,9 @@ 
         $this->img = $img;
     }
 
+    /**
+     * @param integer $aNum
+     */
     function SetNumColors($aNum) {
         $this->numcolors=$aNum;
     }
@@ -331,6 +334,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
+     */
     function FilledFlatPolygon($pts,$from_color,$to_color) {
         if( count($pts) == 0 ) return;
 

include/jpgraph/jpgraph_iconplot.php

Doc Comments +4 added lines

@@ -130,6 +130,10 @@
         return $this->_Stroke($dummy,null,null,true);
     }
 
+    /**
+     * @param double $x
+     * @param double $y
+     */
     function _Stroke($aImg,$x=null,$y=null,$aReturnWidthHeight=false) {
         if( $this->iFile != '' && $this->iCountryFlag != '' ) {
             JpGraphError::RaiseL(8003);//('It is not possible to specify both an image file and a country flag for the same icon.');

include/jpgraph/jpgraph_imgtrans.php

Doc Comments +4 added lines

@@ -203,6 +203,10 @@
     // * $aBorder, if set to anything besides false this will draw a
     //   a border of the speciied color around the image
     // --------------------------------------------------------------------
+
+    /**
+     * @param integer $aDir
+     */
     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,
         $aMinSize,$aFillColor,$aBorder);

include/jpgraph/jpgraph_legend.inc.php

Doc Comments +3 added lines

@@ -170,6 +170,9 @@
         $this->bkg_gradto = $aTo;
     }
 
+    /**
+     * @param RotImage $aImg
+     */
     function Stroke($aImg) {
         // Constant
         $fillBoxFrameWeight=1;

include/jpgraph/jpgraph_log.php

Doc Comments +13 added lines

@@ -21,6 +21,10 @@ 
     // CONSTRUCTOR
 
     // Log scale is specified using the log of min and max
+
+    /**
+     * @param integer $min
+     */
     function __construct($min,$max,$type="y") {
         parent::__construct($min,$max,$type);
         $this->ticks = new LogTicks();
@@ -94,6 +98,12 @@ 
     // Note that for log autoscale the "maxstep" the fourth argument
     // isn't used. This is just included to give the method the same
     // signature as the linear counterpart.
+
+    /**
+     * @param RotImage $img
+     * @param integer $min
+     * @param integer $maxsteps
+     */
     function AutoScale($img,$min,$max,$maxsteps,$majend=true) {
         if( $min==0 ) $min=1;
 
@@ -143,6 +153,9 @@ 
         return true;
     }
 
+    /**
+     * @param integer $aType
+     */
     function SetLabelLogType($aType) {
         $this->label_logtype = $aType;
     }

include/jpgraph/jpgraph_mgraph.php

Doc Comments +7 added lines

@@ -168,6 +168,10 @@ 
         $this->_gdImgHandle($aGraph->Stroke( _IMG_HANDLER),$x,$y,$fx=0,$fy=0,$w,$h);
     }
 
+    /**
+     * @param integer $x
+     * @param integer $y
+     */
     function _gdImgHandle($agdCanvas,$x,$y,$fx=0,$fy=0,$w=0,$h=0,$mix=100) {
         if( $w == 0 ) {
             $w = @imagesx($agdCanvas);
@@ -208,6 +212,9 @@ 
         $this->footer->iRightMargin += $aShadowWidth;
     }
 
+    /**
+     * @param Image $image
+     */
     function StrokeTitle($image,$w,$h) {
         // Stroke title
         if( $this->title->t !== '' ) {