- More documentation fixes

6 files changed, 55 insertions, 15 deletions

diff --git a/src/interfaces/axis_label_renderer.php b/src/interfaces/axis_label_renderer.php
index e58d913..3e2503e 100644
--- a/src/interfaces/axis_label_renderer.php
+++ b/src/interfaces/axis_label_renderer.php
@@ -175,6 +175,27 @@ abstract class ezcGraphAxisLabelRenderer extends ezcBaseOptions
         }
     }
 
+    /**
+     * Checks for the cutting point of two lines.
+     *
+     * The lines are given by a start position and the direction of the line, 
+     * both as instances of ezcGraphCoordinate. If no cutting point could be 
+     * calculated, because the lines are parallel the function will return 
+     * false. Otherwise the factor returned can be used to calculate the 
+     * cutting point using the following equatation:
+     *  point = $aStart + $factor * $aDir;
+     *
+     * We return the factor instead of the resulting point because it can be 
+     * easily determined from the factor if the cutting point is in "behind"
+     * the line starting point, or if the distance to the cutting point is
+     * bigger then the direction vector is long ( $factor > 1 ).
+     * 
+     * @param ezcGraphCoordinate $aStart 
+     * @param ezcGraphCoordinate $aDir 
+     * @param ezcGraphCoordinate $bStart 
+     * @param ezcGraphCoordinate $bDir 
+     * @return mixed
+     */
     public function determineLineCuttingPoint( ezcGraphCoordinate $aStart, ezcGraphCoordinate $aDir, ezcGraphCoordinate $bStart, ezcGraphCoordinate $bDir )
     {
         // Check if lines are parallel
diff --git a/src/interfaces/dataset_property.php b/src/interfaces/dataset_property.php
index 7fd7d52..fe6a3d7 100644
--- a/src/interfaces/dataset_property.php
+++ b/src/interfaces/dataset_property.php
@@ -40,13 +40,18 @@ abstract class ezcGraphDataSetProperty implements ArrayAccess
     /**
      * Abstract method to contain the check for validity of the value
      * 
-     * @param & $value 
-     * @abstract
-     * @access protected
+     * @param mixed $value 
      * @return void
      */
     abstract protected function checkValue( &$value );
 
+    /**
+     * Constructor
+     * 
+     * @param ezcGraphDataSet $dataset 
+     * @ignore
+     * @return void
+     */
     public function __construct( ezcGraphDataSet $dataset )
     {
         $this->dataset = $dataset;
diff --git a/src/interfaces/driver.php b/src/interfaces/driver.php
index 84ea403..9e4819a 100644
--- a/src/interfaces/driver.php
+++ b/src/interfaces/driver.php
@@ -94,7 +94,7 @@ abstract class ezcGraphDriver
      * is a valid simplification, because we do not have any polygones which 
      * have an inner angle >= 180 degrees.
      * 
-     * @param array( ezcGraphCoordinate ) $points 
+     * @param array(ezcGraphCoordinate) $points 
      * @param float $size 
      * @throws ezcGraphReducementFailedException
      * @return array( ezcGraphCoordinate )
@@ -246,9 +246,11 @@ abstract class ezcGraphDriver
      * )
      * 
      * @param ezcGraphCoordinate $center 
-     * @param mixed $startAngle 
-     * @param mixed $endAngle 
-     * @param mixed $size 
+     * @param float $width
+     * @param float $height
+     * @param float $startAngle 
+     * @param float $endAngle 
+     * @param float $size 
      * @throws ezcGraphReducementFailedException
      * @return array
      */
@@ -418,7 +420,7 @@ abstract class ezcGraphDriver
      * @param float $thickness Line thickness
      * @return void
      */
-    abstract public function drawPolygon( array $points, ezcGraphColor $color, $filled = true, $thickness = 1 );
+    abstract public function drawPolygon( array $points, ezcGraphColor $color, $filled = true, $thickness = 1. );
     
     /**
      * Draws a line 
@@ -429,7 +431,7 @@ abstract class ezcGraphDriver
      * @param float $thickness Line thickness
      * @return void
      */
-    abstract public function drawLine( ezcGraphCoordinate $start, ezcGraphCoordinate $end, ezcGraphColor $color, $thickness = 1 );
+    abstract public function drawLine( ezcGraphCoordinate $start, ezcGraphCoordinate $end, ezcGraphColor $color, $thickness = 1. );
     
     /**
      * Returns boundings of text depending on the available font extension
@@ -656,6 +658,7 @@ abstract class ezcGraphDriver
      * @param float $startAngle Starting angle of circle sector
      * @param float $endAngle Ending angle of circle sector
      * @param ezcGraphColor $color Color of Border
+     * @param bool $filled Fill state
      * @return void
      */
     abstract public function drawCircularArc( ezcGraphCoordinate $center, $width, $height, $size, $startAngle, $endAngle, ezcGraphColor $color, $filled = true );
diff --git a/src/interfaces/element.php b/src/interfaces/element.php
index b2523d5..316efbc 100644
--- a/src/interfaces/element.php
+++ b/src/interfaces/element.php
@@ -243,11 +243,21 @@ abstract class ezcGraphChartElement extends ezcBaseOptions
      * This method receives and returns a part of the canvas where it can be 
      * rendered on.
      * 
-     * @param ezcGraphBoundings $boundings Part of canvase to render element on
+     * @param ezcGraphRenderer $renderer
+     * @param ezcGraphBoundings $boundings
      * @return ezcGraphBoundings Part of canvas, which is still free to draw on
      */
     abstract public function render( ezcGraphRenderer $renderer, ezcGraphBoundings $boundings );
 
+    /**
+     * Returns calculated boundings based on available percentual space of 
+     * given bounding box specified in the elements options and direction of 
+     * the box.
+     * 
+     * @param ezcGraphBoundings $boundings 
+     * @param int $direction 
+     * @return ezcGraphBoundings
+     */
     protected function getTitleSize( ezcGraphBoundings $boundings, $direction = ezcGraph::HORIZONTAL )
     {
         if ( $direction === ezcGraph::HORIZONTAL )
diff --git a/src/interfaces/radar_renderer.php b/src/interfaces/radar_renderer.php
index f959ef0..4f251c4 100644
--- a/src/interfaces/radar_renderer.php
+++ b/src/interfaces/radar_renderer.php
@@ -48,7 +48,7 @@ interface ezcGraphRadarRenderer
         $symbol = ezcGraph::NO_SYMBOL,
         ezcGraphColor $symbolColor = null,
         ezcGraphColor $fillColor = null,
-        $thickness = 1
+        $thickness = 1.
     );
 }
 
diff --git a/src/interfaces/renderer.php b/src/interfaces/renderer.php
index 5cdc60f..2a05b8f 100644
--- a/src/interfaces/renderer.php
+++ b/src/interfaces/renderer.php
@@ -114,7 +114,7 @@ abstract class ezcGraphRenderer
      * @param float $startAngle Start angle
      * @param float $endAngle End angle
      * @param string $label Label of pie segment
-     * @param float $moveOut Move out from middle for hilighting
+     * @param bool $moveOut Move out from middle for hilighting
      * @return void
      */
     abstract public function drawPieSegment(
@@ -186,7 +186,7 @@ abstract class ezcGraphRenderer
         ezcGraphColor $symbolColor = null,
         ezcGraphColor $fillColor = null,
         $axisPosition = 0.,
-        $thickness = 1
+        $thickness = 1.
     );
 
     /**
@@ -204,6 +204,7 @@ abstract class ezcGraphRenderer
      * @param ezcGraphFontOptions $font Font used for highlight string
      * @param string $text Acutual value
      * @param int $size Size of highlight text
+     * @param ezcGraphColor $markLines
      * @return void
      */
     abstract public function drawDataHighlightText(
@@ -225,7 +226,7 @@ abstract class ezcGraphRenderer
      * Will draw a legend in the bounding box
      * 
      * @param ezcGraphBoundings $boundings Bounding of legend
-     * @param ezcGraphChartElementLegend $labels Legend to draw
+     * @param ezcGraphChartElementLegend $legend Legend to draw
      * @param int $type Type of legend: Protrait or landscape
      * @return void
      */
@@ -310,7 +311,7 @@ abstract class ezcGraphRenderer
      * @param ezcGraphCoordinate $start Start point of axis
      * @param ezcGraphCoordinate $end Endpoint of axis
      * @param ezcGraphChartElementAxis $axis Axis to render
-     * @param ezcGraphLabelRenderer $labelClass Used label renderer
+     * @param ezcGraphAxisLabelRenderer $labelClass Used label renderer
      * @return void
      */
     abstract public function drawAxis(