Hei,

shouldn't those be documented as properties?

regards,
Derick


On Thu, 15 Feb 2007, Kore Nordmann wrote:

> Author: Kore Nordmann
> Date: 2007-02-15 14:40:41 +0100 (Thu, 15 Feb 2007)
> New Revision: 4658
> 
> Log:
> - Fixed issue #10055: Improve chart class documentation with chart elements
> Modified:
>    trunk/Graph/ChangeLog
>    trunk/Graph/src/charts/bar.php
>    trunk/Graph/src/charts/line.php
>    trunk/Graph/src/charts/pie.php
> 
> Modified: trunk/Graph/ChangeLog
> ===================================================================
> --- trunk/Graph/ChangeLog     2007-02-15 13:09:36 UTC (rev 4657)
> +++ trunk/Graph/ChangeLog     2007-02-15 13:40:41 UTC (rev 4658)
> @@ -13,6 +13,7 @@
>  - Fixed issue #10056: Fixed drawing order for boxes with background and 
> border
>  - Fixed issue #9950: Improved ezcGraphPolynom::__toString method for more
>    exact output
> +- Fixed issue #10055: Improve chart class documentation with chart elements
>  
>  1.0 - Monday 18 December 2006
>  
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> Modified: trunk/Graph/src/charts/bar.php
> ===================================================================
> --- trunk/Graph/src/charts/bar.php    2007-02-15 13:09:36 UTC (rev 4657)
> +++ trunk/Graph/src/charts/bar.php    2007-02-15 13:40:41 UTC (rev 4658)
> @@ -36,6 +36,22 @@
>   *  $chart->render( 500, 200, 'bar_chart.svg' );
>   * </code>
>   *
> + * Each chart consists of several chart elements which represents logical 
> + * parts of the chart and can be formatted independently. The bar chart
> + * consists of:
> + *  - title ( ezcGraphChartElementText )
> + *  - legend ( ezcGraphChartElementLegend )
> + *  - background ( ezcGraphChartElementBackground )
> + *  - xAxis ( ezcGraphChartElementLabeledAxis )
> + *  - yAxis ( ezcGraphChartElementNumericAxis )
> + *
> + * The type of the axis may be changed and all elements can be configured by
> + * accessing them as properties of the chart:
> + *
> + * <code>
> + *  $chart->legend->position = ezcGraph::RIGHT;
> + * </code>
> + *
>   * @package Graph
>   * @mainclass
>   */
> 
> Modified: trunk/Graph/src/charts/line.php
> ===================================================================
> --- trunk/Graph/src/charts/line.php   2007-02-15 13:09:36 UTC (rev 4657)
> +++ trunk/Graph/src/charts/line.php   2007-02-15 13:40:41 UTC (rev 4658)
> @@ -36,6 +36,22 @@
>   *  $chart->render( 500, 200, 'line_chart.svg' );
>   * </code>
>   *
> + * Each chart consists of several chart elements which represents logical 
> + * parts of the chart and can be formatted independently. The line chart
> + * consists of:
> + *  - title ( ezcGraphChartElementText )
> + *  - legend ( ezcGraphChartElementLegend )
> + *  - background ( ezcGraphChartElementBackground )
> + *  - xAxis ( ezcGraphChartElementLabeledAxis )
> + *  - yAxis ( ezcGraphChartElementNumericAxis )
> + *
> + * The type of the axis may be changed and all elements can be configured by
> + * accessing them as properties of the chart:
> + *
> + * <code>
> + *  $chart->legend->position = ezcGraph::RIGHT;
> + * </code>
> + *
>   * @package Graph
>   * @mainclass
>   */
> 
> Modified: trunk/Graph/src/charts/pie.php
> ===================================================================
> --- trunk/Graph/src/charts/pie.php    2007-02-15 13:09:36 UTC (rev 4657)
> +++ trunk/Graph/src/charts/pie.php    2007-02-15 13:40:41 UTC (rev 4658)
> @@ -30,6 +30,19 @@
>   *  $chart->render( 500, 200, 'line_chart.svg' );
>   * </code>
>   *
> + * Each chart consists of several chart elements which represents logical 
> + * parts of the chart and can be formatted independently. The pie chart
> + * consists of:
> + *  - title ( ezcGraphChartElementText )
> + *  - legend ( ezcGraphChartElementLegend )
> + *  - background ( ezcGraphChartElementBackground )
> + *
> + * All elements can be configured by accessing them as properties of the 
> chart:
> + *
> + * <code>
> + *  $chart->legend->position = ezcGraph::RIGHT;
> + * </code>
> + *
>   * @package Graph
>   * @mainclass
>   */
> 
> 

-- 
Derick Rethans
eZ components Product Manager
eZ systems | http://ez.no
-- 
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components

Reply via email to