From 1a921c1448b7fb0d205afc20034bd725bf9450c0 Mon Sep 17 00:00:00 2001
From: Kore Nordmann <github@kore-nordmann.de>
Date: Thu, 21 Sep 2006 12:56:01 +0000
Subject: - Added documentation - Removed no longer used exceptions

---
 src/exceptions/invalid_dimensions.php       |  2 +-
 src/exceptions/invalid_driver.php           | 25 -------------------------
 src/exceptions/invalid_font.php             | 25 -------------------------
 src/exceptions/invalid_image_file.php       |  3 +--
 src/exceptions/invalid_keys.php             |  4 ++--
 src/exceptions/invalid_renderer.php         | 25 -------------------------
 src/exceptions/no_such_data.php             |  3 +--
 src/exceptions/no_such_dataset.php          |  3 +--
 src/exceptions/no_such_element.php          |  3 +--
 src/exceptions/out_of_boundings.php         |  2 +-
 src/exceptions/too_many_datasets.php        |  4 ++--
 src/exceptions/unknown_chart_type.php       | 25 -------------------------
 src/exceptions/unknown_color_definition.php |  4 ++--
 src/exceptions/unknown_dataset_source.php   | 25 -------------------------
 src/exceptions/unknown_palette.php          | 25 -------------------------
 src/exceptions/unsupported_image_type.php   |  4 ++--
 16 files changed, 14 insertions(+), 168 deletions(-)
 delete mode 100644 src/exceptions/invalid_driver.php
 delete mode 100644 src/exceptions/invalid_font.php
 delete mode 100644 src/exceptions/invalid_renderer.php
 delete mode 100644 src/exceptions/unknown_chart_type.php
 delete mode 100644 src/exceptions/unknown_dataset_source.php
 delete mode 100644 src/exceptions/unknown_palette.php

(limited to 'src/exceptions')

diff --git a/src/exceptions/invalid_dimensions.php b/src/exceptions/invalid_dimensions.php
index e3d98bd..3a76815 100644
--- a/src/exceptions/invalid_dimensions.php
+++ b/src/exceptions/invalid_dimensions.php
@@ -8,7 +8,7 @@
  * @license http://ez.no/licenses/new_bsd New BSD License
  */
 /**
- * Exception thrown when an operation i not possible because of incompatible
+ * Exception thrown when an operation is not possible because of incompatible
  * matrix dimensions.
  *
  * @package Graph
diff --git a/src/exceptions/invalid_driver.php b/src/exceptions/invalid_driver.php
deleted file mode 100644
index 2205bbb..0000000
--- a/src/exceptions/invalid_driver.php
+++ /dev/null
@@ -1,25 +0,0 @@
-<?php
-/**
- * File containing the ezcGraphInvalidDriverException class
- *
- * @package Graph
- * @version //autogen//
- * @copyright Copyright (C) 2005, 2006 eZ systems as. All rights reserved.
- * @license http://ez.no/licenses/new_bsd New BSD License
- */
-/**
- * ezcGraphUnknownChartTypeException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
- *
- * @package Graph
- * @version //autogen//
- */
-class ezcGraphInvalidDriverException extends ezcGraphException
-{
-    public function __construct( $driver )
-    {
-        parent::__construct( "Unknown driver <{$driver}>." );
-    }
-}
-
-?>
diff --git a/src/exceptions/invalid_font.php b/src/exceptions/invalid_font.php
deleted file mode 100644
index 4507c00..0000000
--- a/src/exceptions/invalid_font.php
+++ /dev/null
@@ -1,25 +0,0 @@
-<?php
-/**
- * File containing the ezcGraphInvalidDriverException class
- *
- * @package Graph
- * @version //autogen//
- * @copyright Copyright (C) 2005, 2006 eZ systems as. All rights reserved.
- * @license http://ez.no/licenses/new_bsd New BSD License
- */
-/**
- * ezcGraphUnknownChartTypeException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
- *
- * @package Graph
- * @version //autogen//
- */
-class ezcGraphGdDriverInvalidFontException extends ezcGraphException
-{
-    public function __construct( $font )
-    {
-        parent::__construct( "Unknown font <{$font}>." );
-    }
-}
-
-?>
diff --git a/src/exceptions/invalid_image_file.php b/src/exceptions/invalid_image_file.php
index 87de717..27c4ef8 100644
--- a/src/exceptions/invalid_image_file.php
+++ b/src/exceptions/invalid_image_file.php
@@ -8,8 +8,7 @@
  * @license http://ez.no/licenses/new_bsd New BSD License
  */
 /**
- * ezcGraphUnknownChartTypeException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
+ * Exception thrown when a file can not be used as a image file.
  *
  * @package Graph
  * @version //autogen//
diff --git a/src/exceptions/invalid_keys.php b/src/exceptions/invalid_keys.php
index 29f3137..8e59f21 100644
--- a/src/exceptions/invalid_keys.php
+++ b/src/exceptions/invalid_keys.php
@@ -8,8 +8,8 @@
  * @license http://ez.no/licenses/new_bsd New BSD License
  */
 /**
- * ezcGraphDatasetAverageInvalidKeysException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
+ * Exception thrown when a dataset with non numeric keys is used with average 
+ * datasets.
  *
  * @package Graph
  * @version //autogen//
diff --git a/src/exceptions/invalid_renderer.php b/src/exceptions/invalid_renderer.php
deleted file mode 100644
index 59b576d..0000000
--- a/src/exceptions/invalid_renderer.php
+++ /dev/null
@@ -1,25 +0,0 @@
-<?php
-/**
- * File containing the ezcGraphInvalidRendererException class
- *
- * @package Graph
- * @version //autogen//
- * @copyright Copyright (C) 2005, 2006 eZ systems as. All rights reserved.
- * @license http://ez.no/licenses/new_bsd New BSD License
- */
-/**
- * ezcGraphUnknownChartTypeException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
- *
- * @package Graph
- * @version //autogen//
- */
-class ezcGraphInvalidRendererException extends ezcGraphException
-{
-    public function __construct( $renderer )
-    {
-        parent::__construct( "Unknown renderer <{$renderer}>." );
-    }
-}
-
-?>
diff --git a/src/exceptions/no_such_data.php b/src/exceptions/no_such_data.php
index a6d4315..7250d8f 100644
--- a/src/exceptions/no_such_data.php
+++ b/src/exceptions/no_such_data.php
@@ -8,8 +8,7 @@
  * @license http://ez.no/licenses/new_bsd New BSD License
  */
 /**
- * ezcGraphUnknownChartTypeException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
+ * Exception shown, when trying to access not existing data in datasets.
  *
  * @package Graph
  * @version //autogen//
diff --git a/src/exceptions/no_such_dataset.php b/src/exceptions/no_such_dataset.php
index 73093c9..5a68ea7 100644
--- a/src/exceptions/no_such_dataset.php
+++ b/src/exceptions/no_such_dataset.php
@@ -8,8 +8,7 @@
  * @license http://ez.no/licenses/new_bsd New BSD License
  */
 /**
- * ezcGraphUnknownChartTypeException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
+ * Exception thrown when trying to access a non exising dataset.
  *
  * @package Graph
  * @version //autogen//
diff --git a/src/exceptions/no_such_element.php b/src/exceptions/no_such_element.php
index 6832d23..8dd3d03 100644
--- a/src/exceptions/no_such_element.php
+++ b/src/exceptions/no_such_element.php
@@ -8,8 +8,7 @@
  * @license http://ez.no/licenses/new_bsd New BSD License
  */
 /**
- * ezcGraphUnknownChartTypeException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
+ * Exception thrown when trying to access a non existing chart element.
  *
  * @package Graph
  * @version //autogen//
diff --git a/src/exceptions/out_of_boundings.php b/src/exceptions/out_of_boundings.php
index 8fe5848..8a97352 100644
--- a/src/exceptions/out_of_boundings.php
+++ b/src/exceptions/out_of_boundings.php
@@ -8,7 +8,7 @@
  * @license http://ez.no/licenses/new_bsd New BSD License
  */
 /**
- * Exception thrown when a rrequested matrix value is out of the boundings of 
+ * Exception thrown when a requested matrix value is out of the boundings of 
  * the matrix.
  *
  * @package Graph
diff --git a/src/exceptions/too_many_datasets.php b/src/exceptions/too_many_datasets.php
index 3578212..93ba866 100644
--- a/src/exceptions/too_many_datasets.php
+++ b/src/exceptions/too_many_datasets.php
@@ -8,8 +8,8 @@
  * @license http://ez.no/licenses/new_bsd New BSD License
  */
 /**
- * ezcGraphUnknownChartTypeException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
+ * Exception thrown when trying to insert too many data sets in a data set 
+ * container.
  *
  * @package Graph
  * @version //autogen//
diff --git a/src/exceptions/unknown_chart_type.php b/src/exceptions/unknown_chart_type.php
deleted file mode 100644
index df5596b..0000000
--- a/src/exceptions/unknown_chart_type.php
+++ /dev/null
@@ -1,25 +0,0 @@
-<?php
-/**
- * File containing the ezcGraphUnknownChartTypeException class
- *
- * @package Graph
- * @version //autogen//
- * @copyright Copyright (C) 2005, 2006 eZ systems as. All rights reserved.
- * @license http://ez.no/licenses/new_bsd New BSD License
- */
-/**
- * ezcGraphUnknownChartTypeException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
- *
- * @package Graph
- * @version //autogen//
- */
-class ezcGraphUnknownChartTypeException extends ezcGraphException
-{
-    public function __construct( $chartType )
-    {
-        parent::__construct( "Unknown chart type <{$chartType}>." );
-    }
-}
-
-?>
diff --git a/src/exceptions/unknown_color_definition.php b/src/exceptions/unknown_color_definition.php
index 5dbb524..9693fa4 100644
--- a/src/exceptions/unknown_color_definition.php
+++ b/src/exceptions/unknown_color_definition.php
@@ -8,8 +8,8 @@
  * @license http://ez.no/licenses/new_bsd New BSD License
  */
 /**
- * ezcGraphUnknownChartTypeException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
+ * Exception thrown, when a given value could not be interpreted as a color by
+ * ezcGraphColor.
  *
  * @package Graph
  * @version //autogen//
diff --git a/src/exceptions/unknown_dataset_source.php b/src/exceptions/unknown_dataset_source.php
deleted file mode 100644
index 7bd719a..0000000
--- a/src/exceptions/unknown_dataset_source.php
+++ /dev/null
@@ -1,25 +0,0 @@
-<?php
-/**
- * File containing the ezcGraphUnknownDataSetSourceException class
- *
- * @package Graph
- * @version //autogen//
- * @copyright Copyright (C) 2005, 2006 eZ systems as. All rights reserved.
- * @license http://ez.no/licenses/new_bsd New BSD License
- */
-/**
- * ezcGraphUnknownChartTypeException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
- *
- * @package Graph
- * @version //autogen//
- */
-class ezcGraphUnknownDataSetSourceException extends ezcGraphException
-{
-    public function __construct( $source )
-    {
-        parent::__construct( 'Your provided data which could not be handled as a dataset.' );
-    }
-}
-
-?>
diff --git a/src/exceptions/unknown_palette.php b/src/exceptions/unknown_palette.php
deleted file mode 100644
index 749f7ec..0000000
--- a/src/exceptions/unknown_palette.php
+++ /dev/null
@@ -1,25 +0,0 @@
-<?php
-/**
- * File containing the ezcGraphUnknownPaletteException class
- *
- * @package Graph
- * @version //autogen//
- * @copyright Copyright (C) 2005, 2006 eZ systems as. All rights reserved.
- * @license http://ez.no/licenses/new_bsd New BSD License
- */
-/**
- * ezcGraphUnknownPaletteException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
- *
- * @package Graph
- * @version //autogen//
- */
-class ezcGraphUnknownPaletteException extends ezcGraphException
-{
-    public function __construct( $name )
-    {
-        parent::__construct( "No palette with name <{$name}> could be found." );
-    }
-}
-
-?>
diff --git a/src/exceptions/unsupported_image_type.php b/src/exceptions/unsupported_image_type.php
index e8d484a..7072287 100644
--- a/src/exceptions/unsupported_image_type.php
+++ b/src/exceptions/unsupported_image_type.php
@@ -8,8 +8,8 @@
  * @license http://ez.no/licenses/new_bsd New BSD License
  */
 /**
- * ezcGraphUnknownChartTypeException is the exception which is thrown when the
- * factory method tries to return an instance of an unknown chart type
+ * Exception thrown if the image type is not supported and therefore could not
+ * be used in the gd driver.
  *
  * @package Graph
  * @version //autogen//
-- 
cgit v1.1