From 60b57df156dd738a6091a46fb9cf2552d475972d Mon Sep 17 00:00:00 2001
From: Kore Nordmann <github@kore-nordmann.de>
Date: Tue, 12 Jun 2007 11:51:35 +0000
Subject: - Commented exception constructors

---
 src/exceptions/date_parsing.php                   |  7 +++++++
 src/exceptions/flash_bitmap_boundings.php         | 10 ++++++++++
 src/exceptions/flash_bitmap_type.php              |  8 +++++++-
 src/exceptions/font_rendering.php                 | 10 ++++++++++
 src/exceptions/font_type.php                      |  8 ++++++++
 src/exceptions/incompatible_driver.php            |  8 ++++++++
 src/exceptions/invalid_data.php                   |  7 +++++++
 src/exceptions/invalid_data_source.php            |  7 +++++++
 src/exceptions/invalid_dimensions.php             | 10 ++++++++++
 src/exceptions/invalid_display_type.php           |  7 +++++++
 src/exceptions/invalid_font.php                   |  8 ++++++++
 src/exceptions/invalid_id.php                     |  7 +++++++
 src/exceptions/invalid_image_file.php             |  7 +++++++
 src/exceptions/invalid_keys.php                   |  8 +++++++-
 src/exceptions/no_data.php                        |  6 ++++++
 src/exceptions/no_such_data.php                   |  7 +++++++
 src/exceptions/no_such_dataset.php                |  7 +++++++
 src/exceptions/no_such_element.php                |  7 +++++++
 src/exceptions/not_rendered.php                   |  7 +++++++
 src/exceptions/out_of_boundings.php               | 10 ++++++++++
 src/exceptions/out_of_logarithmical_boundings.php |  7 +++++++
 src/exceptions/reducement_failed.php              |  6 ++++++
 src/exceptions/too_many_datasets.php              |  6 ++++++
 src/exceptions/unknown_color_definition.php       |  7 +++++++
 src/exceptions/unregular_steps.php                |  6 ++++++
 src/exceptions/unsupported_image_type.php         |  7 +++++++
 26 files changed, 193 insertions(+), 2 deletions(-)

diff --git a/src/exceptions/date_parsing.php b/src/exceptions/date_parsing.php
index bf3fc0d..2771ed6 100644
--- a/src/exceptions/date_parsing.php
+++ b/src/exceptions/date_parsing.php
@@ -16,6 +16,13 @@
  */
 class ezcGraphErrorParsingDateException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param mixed $value
+     * @return void
+     * @ignore
+     */
     public function __construct( $value )
     {
         $type = gettype( $value );
diff --git a/src/exceptions/flash_bitmap_boundings.php b/src/exceptions/flash_bitmap_boundings.php
index 4a110aa..939a827 100644
--- a/src/exceptions/flash_bitmap_boundings.php
+++ b/src/exceptions/flash_bitmap_boundings.php
@@ -16,6 +16,16 @@
  */
 class ezcGraphFlashBitmapBoundingsException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param int $imageWidth
+     * @param int $imageHeight
+     * @param int $reqWidth
+     * @param int $reqHeight
+     * @return void
+     * @ignore
+     */
     public function __construct( $imageWidth, $imageHeight, $reqWidth, $reqHeight )
     {
         parent::__construct( "Flash does not support bitmap scaling, so that it is up to you to scale the image '$imageWidth' * '$imageHeight' to '$reqWidth' * '$reqHeight'." );
diff --git a/src/exceptions/flash_bitmap_type.php b/src/exceptions/flash_bitmap_type.php
index 1d31009..b596787 100644
--- a/src/exceptions/flash_bitmap_type.php
+++ b/src/exceptions/flash_bitmap_type.php
@@ -16,7 +16,13 @@
  */
 class ezcGraphFlashBitmapTypeException extends ezcGraphException
 {
-    public function __construct( $type )
+    /**
+     * Constructor
+     * 
+     * @return void
+     * @ignore
+     */
+    public function __construct()
     {
         parent::__construct( "Flash can only read non interlaced JPEGs." );
     }
diff --git a/src/exceptions/font_rendering.php b/src/exceptions/font_rendering.php
index 4c17e3b..33c531c 100644
--- a/src/exceptions/font_rendering.php
+++ b/src/exceptions/font_rendering.php
@@ -16,6 +16,16 @@
  */
 class ezcGraphFontRenderingException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param string $string
+     * @param float $size
+     * @param int $width
+     * @param int $height
+     * @return void
+     * @ignore
+     */
     public function __construct( $string, $size, $width, $height )
     {
         parent::__construct( "Could not fit string '{$string}' with font size '{$size}' in box '{$width} * {$height}'.
diff --git a/src/exceptions/font_type.php b/src/exceptions/font_type.php
index d5fef9d..a5aef55 100644
--- a/src/exceptions/font_type.php
+++ b/src/exceptions/font_type.php
@@ -15,6 +15,14 @@
  */
 class ezcGraphUnknownFontTypeException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param string $file
+     * @param string $extension
+     * @return void
+     * @ignore
+     */
     public function __construct( $file, $extension )
     {
         parent::__construct( "Unknown font type '{$extension}' of file '{$file}'." );
diff --git a/src/exceptions/incompatible_driver.php b/src/exceptions/incompatible_driver.php
index 16fe6aa..c1ea924 100644
--- a/src/exceptions/incompatible_driver.php
+++ b/src/exceptions/incompatible_driver.php
@@ -16,6 +16,14 @@
  */
 class ezcGraphToolsIncompatibleDriverException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param mixed $driver
+     * @param string $accepted
+     * @return void
+     * @ignore
+     */
     public function __construct( $driver, $accepted )
     {
         $driverClass = get_class( $driver );
diff --git a/src/exceptions/invalid_data.php b/src/exceptions/invalid_data.php
index 4c8f3f2..950f397 100644
--- a/src/exceptions/invalid_data.php
+++ b/src/exceptions/invalid_data.php
@@ -16,6 +16,13 @@
  */
 class ezcGraphInvalidDataException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param string $message
+     * @return void
+     * @ignore
+     */
     public function __construct( $message )
     {
         parent::__construct( "You provided unusable data: '$message'." );
diff --git a/src/exceptions/invalid_data_source.php b/src/exceptions/invalid_data_source.php
index 4b24334..9ed9e42 100644
--- a/src/exceptions/invalid_data_source.php
+++ b/src/exceptions/invalid_data_source.php
@@ -16,6 +16,13 @@
  */
 class ezcGraphInvalidArrayDataSourceException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param mixed $value
+     * @return void
+     * @ignore
+     */
     public function __construct( $value )
     {
         $type = gettype( $value );
diff --git a/src/exceptions/invalid_dimensions.php b/src/exceptions/invalid_dimensions.php
index 64343bc..1ab1346 100644
--- a/src/exceptions/invalid_dimensions.php
+++ b/src/exceptions/invalid_dimensions.php
@@ -16,6 +16,16 @@
  */
 class ezcGraphMatrixInvalidDimensionsException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param int $rows
+     * @param int $colums
+     * @param int $dRows
+     * @param int $dColumns
+     * @return void
+     * @ignore
+     */
     public function __construct( $rows, $columns, $dRows, $dColumns )
     {
         parent::__construct( "Matrix '{$dRows}, {$dColumns}' is incompatible with matrix '{$rows}, {$columns}' for requested operation." );
diff --git a/src/exceptions/invalid_display_type.php b/src/exceptions/invalid_display_type.php
index c0f7909..40214d1 100644
--- a/src/exceptions/invalid_display_type.php
+++ b/src/exceptions/invalid_display_type.php
@@ -15,6 +15,13 @@
  */
 class ezcGraphInvalidDisplayTypeException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param int $type
+     * @return void
+     * @ignore
+     */
     public function __construct( $type )
     {
         $chartTypeNames = array(
diff --git a/src/exceptions/invalid_font.php b/src/exceptions/invalid_font.php
index 4cf9c4b..23d61d9 100644
--- a/src/exceptions/invalid_font.php
+++ b/src/exceptions/invalid_font.php
@@ -15,6 +15,14 @@
  */
 class ezcGraphInvalidFontTypeException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param int $type
+     * @param string $driver
+     * @return void
+     * @ignore
+     */
     public function __construct( $type, $driver )
     {
         $fontNames = array(
diff --git a/src/exceptions/invalid_id.php b/src/exceptions/invalid_id.php
index b3d31b5..dc7f995 100644
--- a/src/exceptions/invalid_id.php
+++ b/src/exceptions/invalid_id.php
@@ -16,6 +16,13 @@
  */
 class ezcGraphSvgDriverInvalidIdException extends ezcGraphException
 {
+    /**
+     * Constructor
+     *
+     * @param string $id
+     * @return void
+     * @ignore
+     */
     public function __construct( $id )
     {
         parent::__construct( "Could not find element with id '{$id}' in SVG document." );
diff --git a/src/exceptions/invalid_image_file.php b/src/exceptions/invalid_image_file.php
index 64f91a5..3a55aa6 100644
--- a/src/exceptions/invalid_image_file.php
+++ b/src/exceptions/invalid_image_file.php
@@ -15,6 +15,13 @@
  */
 class ezcGraphInvalidImageFileException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param string $image
+     * @return void
+     * @ignore
+     */
     public function __construct( $image )
     {
         parent::__construct( "File '{$image}' is not a valid image." );
diff --git a/src/exceptions/invalid_keys.php b/src/exceptions/invalid_keys.php
index 4206914..7dde875 100644
--- a/src/exceptions/invalid_keys.php
+++ b/src/exceptions/invalid_keys.php
@@ -16,7 +16,13 @@
  */
 class ezcGraphDatasetAverageInvalidKeysException extends ezcGraphException
 {
-    public function __construct( )
+    /**
+     * Constructor
+     * 
+     * @return void
+     * @ignore
+     */
+    public function __construct()
     {
         parent::__construct( "You can not use non numeric keys with Average datasets." );
     }
diff --git a/src/exceptions/no_data.php b/src/exceptions/no_data.php
index f5d98d4..0be9ccd 100644
--- a/src/exceptions/no_data.php
+++ b/src/exceptions/no_data.php
@@ -15,6 +15,12 @@
  */
 class ezcGraphNoDataException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @return void
+     * @ignore
+     */
     public function __construct()
     {
         parent::__construct( "No data sets assigned to chart." );
diff --git a/src/exceptions/no_such_data.php b/src/exceptions/no_such_data.php
index 72f2e3e..de9f554 100644
--- a/src/exceptions/no_such_data.php
+++ b/src/exceptions/no_such_data.php
@@ -15,6 +15,13 @@
  */
 class ezcGraphNoSuchDataException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param string $name
+     * @return void
+     * @ignore
+     */
     public function __construct( $name )
     {
         parent::__construct( "No data with name '{$name}' found." );
diff --git a/src/exceptions/no_such_dataset.php b/src/exceptions/no_such_dataset.php
index 314ee33..a96c961 100644
--- a/src/exceptions/no_such_dataset.php
+++ b/src/exceptions/no_such_dataset.php
@@ -15,6 +15,13 @@
  */
 class ezcGraphNoSuchDataSetException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param string $name
+     * @return void
+     * @ignore
+     */
     public function __construct( $name )
     {
         parent::__construct( "No dataset with identifier '{$name}' could be found." );
diff --git a/src/exceptions/no_such_element.php b/src/exceptions/no_such_element.php
index c3cdd65..9798221 100644
--- a/src/exceptions/no_such_element.php
+++ b/src/exceptions/no_such_element.php
@@ -15,6 +15,13 @@
  */
 class ezcGraphNoSuchElementException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param string $name
+     * @return void
+     * @ignore
+     */
     public function __construct( $name )
     {
         parent::__construct( "No chart element with name '{$name}' found." );
diff --git a/src/exceptions/not_rendered.php b/src/exceptions/not_rendered.php
index 8b53e95..b95d780 100644
--- a/src/exceptions/not_rendered.php
+++ b/src/exceptions/not_rendered.php
@@ -16,6 +16,13 @@
  */
 class ezcGraphToolsNotRenderedException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param ezcGraphChart $chart
+     * @return void
+     * @ignore
+     */
     public function __construct( $chart )
     {
         parent::__construct( "Chart is not yet rendered." );
diff --git a/src/exceptions/out_of_boundings.php b/src/exceptions/out_of_boundings.php
index e0bf35c..856348d 100644
--- a/src/exceptions/out_of_boundings.php
+++ b/src/exceptions/out_of_boundings.php
@@ -16,6 +16,16 @@
  */
 class ezcGraphMatrixOutOfBoundingsException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param int $rows
+     * @param int $columns
+     * @param int $dRows
+     * @param int $dColumns
+     * @return void
+     * @ignore
+     */
     public function __construct( $rows, $columns, $rPos, $cPos )
     {
         parent::__construct( "Position '{$rPos}, {$cPos}' is out of the matrix boundings '{$rows}, {$columns}'." );
diff --git a/src/exceptions/out_of_logarithmical_boundings.php b/src/exceptions/out_of_logarithmical_boundings.php
index 12418ed..6e69113 100644
--- a/src/exceptions/out_of_logarithmical_boundings.php
+++ b/src/exceptions/out_of_logarithmical_boundings.php
@@ -16,6 +16,13 @@
  */
 class ezcGraphOutOfLogithmicalBoundingsException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param int minimum
+     * @return void
+     * @ignore
+     */
     public function __construct( $minimum )
     {
         parent::__construct( "Value '$minimum' exceeds displayable values on a logarithmical scaled axis." );
diff --git a/src/exceptions/reducement_failed.php b/src/exceptions/reducement_failed.php
index f14e88d..fb5e649 100644
--- a/src/exceptions/reducement_failed.php
+++ b/src/exceptions/reducement_failed.php
@@ -16,6 +16,12 @@
  */
 class ezcGraphReducementFailedException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @return void
+     * @ignore
+     */
     public function __construct()
     {
         parent::__construct( "Reducement of shape failed, because it was already too small." );
diff --git a/src/exceptions/too_many_datasets.php b/src/exceptions/too_many_datasets.php
index 3b2114e..95e0ac6 100644
--- a/src/exceptions/too_many_datasets.php
+++ b/src/exceptions/too_many_datasets.php
@@ -16,6 +16,12 @@
  */
 class ezcGraphTooManyDataSetsExceptions extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @return void
+     * @ignore
+     */
     public function __construct()
     {
         parent::__construct( "You tried to insert to many datasets." );
diff --git a/src/exceptions/unknown_color_definition.php b/src/exceptions/unknown_color_definition.php
index 3414ec9..b424478 100644
--- a/src/exceptions/unknown_color_definition.php
+++ b/src/exceptions/unknown_color_definition.php
@@ -16,6 +16,13 @@
  */
 class ezcGraphUnknownColorDefinitionException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param mixed $definition
+     * @return void
+     * @ignore
+     */
     public function __construct( $definition )
     {
         parent::__construct( "Unknown color definition '{$definition}'." );
diff --git a/src/exceptions/unregular_steps.php b/src/exceptions/unregular_steps.php
index 12e9dad..7c67b5c 100644
--- a/src/exceptions/unregular_steps.php
+++ b/src/exceptions/unregular_steps.php
@@ -16,6 +16,12 @@
  */
 class ezcGraphUnregularStepsException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @return void
+     * @ignore
+     */
     public function __construct()
     {
         parent::__construct( "Bar charts do not support axis with unregualr steps sizes." );
diff --git a/src/exceptions/unsupported_image_type.php b/src/exceptions/unsupported_image_type.php
index 333e06f..086ef0f 100644
--- a/src/exceptions/unsupported_image_type.php
+++ b/src/exceptions/unsupported_image_type.php
@@ -16,6 +16,13 @@
  */
 class ezcGraphGdDriverUnsupportedImageTypeException extends ezcGraphException
 {
+    /**
+     * Constructor
+     * 
+     * @param int $type
+     * @return void
+     * @ignore
+     */
     public function __construct( $type )
     {
         $typeName = array(
-- 
cgit v1.1