XoopsModules25x / xhelp

include/jpgraph/jpgraph_pie3d.php

Doc Comments +40 added lines

@@ -64,6 +64,10 @@ 
 
     // Specify projection angle for 3D in degrees
     // Must be between 20 and 70 degrees
+
+    /**
+     * @param integer $a
+     */
     function SetAngle($a) {
         if( $a<5 || $a>90 ) {
             JpGraphError::RaiseL(14002);
@@ -74,6 +78,15 @@ 
         }
     }
 
+    /**
+     * @param integer $i
+     * @param double $xc
+     * @param double $yc
+     * @param double $height
+     * @param double $width
+     * @param double $sa
+     * @param double $ea
+     */
     function Add3DSliceToCSIM($i,$xc,$yc,$height,$width,$thick,$sa,$ea) {  //Slice number, ellipse centre (x,y), height, width, start angle, end angle
 
         $sa *= M_PI/180;
@@ -175,6 +188,10 @@ 
     }
 
     // Draw one 3D pie slice at position ($xc,$yc) with height $z
+
+    /**
+     * @param double $h
+     */
     function Pie3DSlice($img,$xc,$yc,$w,$h,$sa,$ea,$z,$fillcolor,$shadow=0.65) {
 
         // Due to the way the 3D Pie algorithm works we are
@@ -384,6 +401,9 @@ 
         $img->PopColor();
     }
 
+    /**
+     * @param integer $aStart
+     */
     function SetStartAngle($aStart) {
         if( $aStart < 0 || $aStart > 360 ) {
             JpGraphError::RaiseL(14004);//('Slice start angle must be between 0 and 360 degrees.');
@@ -392,6 +412,13 @@ 
     }
 
     // Draw a 3D Pie
+
+    /**
+     * @param integer $aaoption
+     * @param double $yc
+     * @param integer $angle
+     * @param double $z
+     */
     function Pie3D($aaoption,$img,$data,$colors,$xc,$yc,$d,$angle,$z,
     $shadow=0.65,$startangle=0,$edgecolor="",$edgeweight=1) {
 
@@ -710,6 +737,13 @@ 
         $img->PopColor();
     }
 
+    /**
+     * @param double $sa
+     * @param double $ea
+     * @param double $h
+     * @param string $edgecolor
+     * @param boolean $fulledge
+     */
     function StrokeFullSliceFrame($img,$xc,$yc,$sa,$ea,$w,$h,$z,$edgecolor,$exploderadius,$fulledge) {
         $step = 0.02;
 
@@ -865,6 +899,12 @@ 
     // PRIVATE METHODS
 
     // Position the labels of each slice
+
+    /**
+     * @param double $a
+     * @param double $xp
+     * @param double $yp
+     */
     function StrokeLabels($label,$img,$a,$xp,$yp,$z) {
         $this->value->halign="left";
         $this->value->valign="top";

include/jpgraph/jpgraph_plotband.php

Doc Comments +3 added lines

@@ -48,6 +48,9 @@
     protected $linespacing; // Line spacing in pixels
     protected $iBackgroundColor=-1;  // Default is no background fill
 
+    /**
+     * @param string $aColor
+     */
     function __construct($aColor,$aWeight=1) {
         $this->color = $aColor;
         $this->weight = $aWeight;

include/jpgraph/jpgraph_plotmark.inc.php

Doc Comments +19 added lines

@@ -40,6 +40,10 @@ 
     }
     //---------------
     // PUBLIC METHODS
+
+    /**
+     * @param integer $aType
+     */
     function SetType($aType,$aFileName='',$aScale=1.0) {
         $this->type = $aType;
         if( $aType == MARK_IMG && $aFileName=='' ) {
@@ -61,10 +65,16 @@ 
         return $this->type;
     }
 
+    /**
+     * @param string $aColor
+     */
     function SetColor($aColor) {
         $this->color=$aColor;
     }
 
+    /**
+     * @param string $aFillColor
+     */
     function SetFillColor($aFillColor) {
         $this->fill_color = $aFillColor;
     }
@@ -78,6 +88,9 @@ 
         $this->width=$aWidth;
     }
 
+    /**
+     * @param integer $aWidth
+     */
     function SetWidth($aWidth) {
         $this->width=$aWidth;
     }
@@ -123,6 +136,9 @@ 
         return $this->csimareas;
     }
 
+    /**
+     * @param double[] $aPts
+     */
     function AddCSIMPoly($aPts) {
         $coords = round($aPts[0]).", ".round($aPts[1]);
         $n = count($aPts)/2;
@@ -489,6 +505,9 @@ 
 // Only supposed to b called as statics
 class FlagCache {
 
+    /**
+     * @param integer $aSize
+     */
     static function GetFlagImgByName($aSize,$aName) {
         global $_gFlagCache;
         require_once('jpgraph_flags.php');

include/jpgraph/jpgraph_polar.php

Doc Comments +28 added lines

@@ -159,6 +159,9 @@ 
     private $show_angle_tick=true;
     private $radius_tick_color='black';
 
+    /**
+     * @param RotImage $img
+     */
     function __construct($img,$aScale) {
         parent::__construct($img,$aScale);
     }
@@ -216,6 +219,10 @@ 
     }
 
     // Private methods
+
+    /**
+     * @param integer $pos
+     */
     function StrokeGrid($pos) {
         $x = round($this->img->left_margin + $this->img->plotwidth/2);
         $this->scale->ticks->Stroke($this->img,$this->scale,$pos);
@@ -307,6 +314,9 @@ 
         }
     }
 
+    /**
+     * @param integer $pos
+     */
     function StrokeAngleLabels($pos,$type) {
 
         if( !$this->show_angle_label )
@@ -492,6 +502,9 @@ 
         }
     }
 
+    /**
+     * @param integer $pos
+     */
     function Stroke($pos,$dummy=true) {
 
         $this->img->SetLineWeight($this->weight);
@@ -589,6 +602,11 @@ 
     private $graph;
     public $clockwise=false;
 
+    /**
+     * @param integer $aMax
+     * @param PolarGraph $graph
+     * @param boolean $aClockwise
+     */
     function __construct($aMax,$graph,$aClockwise) {
         parent::__construct(0,$aMax,'x');
         $this->graph = $graph;
@@ -599,6 +617,9 @@ 
         $this->clockwise = $aFlg;
     }
 
+    /**
+     * @param integer $v
+     */
     function _Translate($v) {
         return parent::Translate($v);
     }
@@ -634,6 +655,10 @@ 
     private $graph;
     public $clockwise=false;
 
+    /**
+     * @param integer $aMax
+     * @param PolarGraph $graph
+     */
     function __construct($aMax,$graph,$aClockwise=false) {
         parent::__construct(0,$aMax,'x');
         $this->graph = $graph;
@@ -688,6 +713,9 @@ 
         $this->SetMarginColor('white');
     }
 
+    /**
+     * @param integer $aDense
+     */
     function SetDensity($aDense) {
         $this->SetTickDensity(TICKD_NORMAL,$aDense);
     }

include/jpgraph/jpgraph_radar.php

Doc Comments +27 added lines

@@ -220,6 +220,10 @@ 
     private $title_color='navy';
     private $len=0;
 
+    /**
+     * @param RotImage $img
+     * @param LinearScale $aScale
+     */
     function __construct($img,$aScale,$color=array(0,0,0)) {
         parent::__construct($img,$aScale,$color);
         $this->len = $img->plotheight;
@@ -233,6 +237,11 @@ 
     // $aAxisAngle = Axis angle
     // $grid   = Returns an array with positions used to draw the grid
     // $lf   = Label flag, TRUE if the axis should have labels
+
+    /**
+     * @param double $aAxisAngle
+     * @param boolean $lf
+     */
     function Stroke($pos,$aAxisAngle,&$grid,$title,$lf) {
         $this->img->SetColor($this->color);
 
@@ -280,6 +289,9 @@ 
         $this->_StrokeAxisTitle($pos,$aAxisAngle,$title);
     }
 
+    /**
+     * @param double $pos
+     */
     function _StrokeAxisTitle($pos,$aAxisAngle,$title) {
         $this->title->Set($title);
         $marg=6+$this->title->margin;
@@ -359,6 +371,9 @@ 
         $this->show=$aShowMajor;
     }
 
+    /**
+     * @param RotImage $img
+     */
     function Stroke($img,$grid) {
         if( !$this->show ) {
             return;
@@ -436,6 +451,9 @@ 
         $this->weight=$w;
     }
 
+    /**
+     * @param boolean $aColor
+     */
     function SetFillColor($aColor) {
         $this->fill_color = $aColor;
         $this->fill = true;
@@ -575,6 +593,9 @@ 
         $this->yscale->ticks->SupressMinorTickMarks(!$aFlag);
     }
 
+    /**
+     * @param string $axtype
+     */
     function SetScale($axtype,$ymin=1,$ymax=1,$dummy1=null,$dumy2=null) {
         if( $axtype != 'lin' && $axtype != 'log' ) {
             JpGraphError::RaiseL(18003,$axtype);
@@ -606,6 +627,9 @@ 
         $this->SetSize($aSize);
     }
 
+    /**
+     * @param integer $densy
+     */
     function SetTickDensity($densy=TICKD_NORMAL,$dummy1=null) {
         $this->ytick_factor=25;
         switch( $densy ) {
@@ -646,6 +670,9 @@ 
         }
     }
 
+    /**
+     * @param integer[] $aColor
+     */
     function SetColor($aColor) {
         $this->SetMarginColor($aColor);
     }

include/jpgraph/jpgraph_regstat.php

Doc Comments +1 added lines, -1 removed lines

@@ -169,7 +169,7 @@
      * range 0 $mu < 1 where 0 is tha start point and 1 is the end point. Note that every newly computed
      * point depends on all the existing points
      *
-     * @param $mu Position on the bezier curve
+     * @param double $mu Position on the bezier curve
      * @return array($x, $y)
      */
     function GetPoint($mu) {

include/jpgraph/jpgraph_rgb.inc.php

Doc Comments +4 added lines

@@ -594,6 +594,10 @@
     // The $aDynamicRange specified how much of the dynamic range we shold use
     // a value of 1.0 give the full dyanmic range and a lower value give more dark
     // colors. In the extreme of 0.0 then all colors will be black.
+
+    /**
+     * @param integer $aVal
+     */
     static function GetSpectrum($aVal,$aDynamicRange=1.0) {
         if( $aVal < 0 || $aVal > 1.0001 ) {
             return array(0,0,0); // Invalid case - just return black

include/jpgraph/jpgraph_stock.php

Doc Comments +7 added lines

@@ -164,6 +164,13 @@
     }
 
     // A hook for subclasses to modify the plot
+
+    /**
+     * @param integer $i
+     * @param double $xl
+     * @param double $xr
+     * @param boolean $neg
+     */
     function ModBox($img,$xscale,$yscale,$i,$xl,$xr,$neg) {}
 
 } // Class

include/jpgraph/jpgraph_text.inc.php

Doc Comments +20 added lines

@@ -71,11 +71,19 @@ 
     }
 
     // Alias
+
+    /**
+     * @param string $aHAlign
+     */
     function SetAlign($aHAlign,$aVAlign="top",$aParagraphAlign="") {
         $this->Align($aHAlign,$aVAlign,$aParagraphAlign);
     }
 
     // Specifies the alignment for a multi line text
+
+    /**
+     * @param string $aAlign
+     */
     function ParagraphAlign($aAlign) {
         $this->paragraph_align = $aAlign;
     }
@@ -141,6 +149,10 @@ 
     }
 
     // Center the text between $left and $right coordinates
+
+    /**
+     * @param integer $aLeft
+     */
     function Center($aLeft,$aRight,$aYAbsPos=false) {
         $this->x = $aLeft + ($aRight-$aLeft )/2;
         $this->halign = "center";
@@ -149,6 +161,10 @@ 
     }
 
     // Set text color
+
+    /**
+     * @param string $aColor
+     */
     function SetColor($aColor) {
         $this->color = $aColor;
     }
@@ -203,6 +219,10 @@ 
 
     // Set the margin which will be interpretated differently depending
     // on the context.
+
+    /**
+     * @param integer $aMarg
+     */
     function SetMargin($aMarg) {
         $this->margin = $aMarg;
     }