Author: kn
Date: Mon Nov 26 12:31:33 2007
New Revision: 6799
Log:
- Fixed doc blocks
# Issues found by docanalysis script
Modified:
trunk/Graph/src/charts/line.php
trunk/Graph/src/datasets/property/axis.php
trunk/Graph/src/element/axis.php
trunk/Graph/src/interfaces/odometer_renderer.php
trunk/Graph/src/interfaces/renderer.php
trunk/Graph/src/interfaces/stacked_bar_renderer.php
trunk/Graph/src/renderer/2d.php
trunk/Graph/src/renderer/3d.php
Modified: trunk/Graph/src/charts/line.php
==============================================================================
--- trunk/Graph/src/charts/line.php [iso-8859-1] (original)
+++ trunk/Graph/src/charts/line.php [iso-8859-1] Mon Nov 26 12:31:33 2007
@@ -418,8 +418,8 @@
* Check if renderer supports features requested by some special chart
* options.
*
- * @throw ezcBaseValueException
- * If some feature is not supported
+ * @throws ezcBaseValueException
+ * If some feature is not supported
*
* @return void
*/
@@ -638,7 +638,7 @@
*
* @param int $width
* @param int $height
- * @apichange
+ * @apichange
* @return void
*/
public function renderToOutput( $width, $height )
Modified: trunk/Graph/src/datasets/property/axis.php
==============================================================================
--- trunk/Graph/src/datasets/property/axis.php [iso-8859-1] (original)
+++ trunk/Graph/src/datasets/property/axis.php [iso-8859-1] Mon Nov 26 12:31:33
2007
@@ -18,7 +18,7 @@
/**
* Chacks if value is really an axis
*
- * @param &$value
+ * @param ezcGraphChartElementAxis $value
* @return void
*/
protected function checkValue( &$value )
Modified: trunk/Graph/src/element/axis.php
==============================================================================
--- trunk/Graph/src/element/axis.php [iso-8859-1] (original)
+++ trunk/Graph/src/element/axis.php [iso-8859-1] Mon Nov 26 12:31:33 2007
@@ -19,11 +19,12 @@
* Color of major majorGrid.
* @property ezcGraphColor $minorGrid
* Color of minor majorGrid.
- * @TODO: Move next two options to numeric axis
* @property mixed $majorStep
- * Labeled major steps displayed on the axis.
+ * Labeled major steps displayed on the axis. @TODO: Should be moved
+ * to numeric axis.
* @property mixed $minorStep
- * Non labeled minor steps on the axis.
+ * Non labeled minor steps on the axis. @TODO: Should be moved to
+ * numeric axis.
* @property string $formatString
* Formatstring to use for labeling of the axis.
* @property string $label
Modified: trunk/Graph/src/interfaces/odometer_renderer.php
==============================================================================
--- trunk/Graph/src/interfaces/odometer_renderer.php [iso-8859-1] (original)
+++ trunk/Graph/src/interfaces/odometer_renderer.php [iso-8859-1] Mon Nov 26
12:31:33 2007
@@ -21,6 +21,7 @@
* Render odometer chart
*
* @param ezcGraphBoundings $boundings
+ * @param ezcGraphChartElementAxis $axis
* @param ezcGraphOdometerChartOptions $options
* @return ezcGraphBoundings
*/
Modified: trunk/Graph/src/interfaces/renderer.php
==============================================================================
--- trunk/Graph/src/interfaces/renderer.php [iso-8859-1] (original)
+++ trunk/Graph/src/interfaces/renderer.php [iso-8859-1] Mon Nov 26 12:31:33
2007
@@ -113,7 +113,7 @@
* @param ezcGraphColor $color Color of pie segment
* @param float $startAngle Start angle
* @param float $endAngle End angle
- * @param string $label Label of pie segment
+ * @param mixed $label Label of pie segment
* @param bool $moveOut Move out from middle for hilighting
* @return void
*/
@@ -250,7 +250,7 @@
* @param int $borderWidth Border width
* @param int $margin Margin
* @param int $padding Padding
- * @param string $title Title of the box
+ * @param mixed $title Title of the box
* @param int $titleSize Size of title in the box
* @return ezcGraphBoundings Remaining inner boundings
*/
Modified: trunk/Graph/src/interfaces/stacked_bar_renderer.php
==============================================================================
--- trunk/Graph/src/interfaces/stacked_bar_renderer.php [iso-8859-1] (original)
+++ trunk/Graph/src/interfaces/stacked_bar_renderer.php [iso-8859-1] Mon Nov 26
12:31:33 2007
@@ -28,8 +28,6 @@
* @param ezcGraphCoordinate $start
* @param ezcGraphCoordinate $position
* @param float $stepSize Space which can be used for bars
- * @param int $dataNumber Number of dataset
- * @param int $dataCount Count of datasets in chart
* @param int $symbol Symbol to draw for line
* @param float $axisPosition Position of axis for drawing filled lines
* @return void
Modified: trunk/Graph/src/renderer/2d.php
==============================================================================
--- trunk/Graph/src/renderer/2d.php [iso-8859-1] (original)
+++ trunk/Graph/src/renderer/2d.php [iso-8859-1] Mon Nov 26 12:31:33 2007
@@ -154,7 +154,7 @@
* @param ezcGraphColor $color Color of pie segment
* @param float $startAngle Start angle
* @param float $endAngle End angle
- * @param string $label Label of pie segment
+ * @param mixed $label Label of pie segment
* @param bool $moveOut Move out from middle for hilighting
* @return void
*/
@@ -584,10 +584,8 @@
* @param ezcGraphContext $context Context of call
* @param ezcGraphColor $color Color of line
* @param ezcGraphCoordinate $start
- * @param ezcGraphCoordinate $end
+ * @param ezcGraphCoordinate $position
* @param float $stepSize Space which can be used for bars
- * @param int $dataNumber Number of dataset
- * @param int $dataCount Count of datasets in chart
* @param int $symbol Symbol to draw for line
* @param float $axisPosition Position of axis for drawing filled lines
* @return void
@@ -1083,7 +1081,7 @@
* @param int $borderWidth Border width
* @param int $margin Margin
* @param int $padding Padding
- * @param string $title Title of the box
+ * @param mixed $title Title of the box
* @param int $titleSize Size of title in the box
* @return ezcGraphBoundings Remaining inner boundings
*/
@@ -1599,6 +1597,7 @@
* Render odometer chart
*
* @param ezcGraphBoundings $boundings
+ * @param ezcGraphChartElementAxis $axis
* @param ezcGraphOdometerChartOptions $options
* @return ezcGraphBoundings
*/
Modified: trunk/Graph/src/renderer/3d.php
==============================================================================
--- trunk/Graph/src/renderer/3d.php [iso-8859-1] (original)
+++ trunk/Graph/src/renderer/3d.php [iso-8859-1] Mon Nov 26 12:31:33 2007
@@ -227,7 +227,7 @@
* @param ezcGraphColor $color Color of pie segment
* @param float $startAngle Start angle
* @param float $endAngle End angle
- * @param string $label Label of pie segment
+ * @param mixed $label Label of pie segment
* @param bool $moveOut Move out from middle for hilighting
* @return void
*/
@@ -1256,8 +1256,6 @@
* @param ezcGraphCoordinate $start
* @param ezcGraphCoordinate $position
* @param float $stepSize Space which can be used for bars
- * @param int $dataNumber Number of dataset
- * @param int $dataCount Count of datasets in chart
* @param int $symbol Symbol to draw for line
* @param float $axisPosition Position of axis for drawing filled lines
* @return void
@@ -1697,7 +1695,7 @@
* @param int $borderWidth Border width
* @param int $margin Margin
* @param int $padding Padding
- * @param string $title Title of the box
+ * @param mixed $title Title of the box
* @param int $titleSize Size of title in the box
* @return ezcGraphBoundings Remaining inner boundings
*/
--
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components
