Permalink
Browse files

Updating inline documentation to include thrown exceptions.

  • Loading branch information...
1 parent 849a379 commit e84372bbf9f738be943f33914cdd7ec365c564bd Matthew A. Mattson committed May 30, 2012
Showing with 8 additions and 4 deletions.
  1. +8 −4 classes/base/db/connection/pool.php
View
12 classes/base/db/connection/pool.php
@@ -126,6 +126,8 @@ public function __set($key, $value) {
* @access public
* @param DB_Connection $connection the connection to be added
* @return boolean whether the connection was added
+ * @throws Kohana_Database_Exception indicates that no new connections
+ * can be added
*/
public function add_connection(DB_Connection $connection) {
if ( ! is_null($connection)) {
@@ -160,9 +162,11 @@ public function count() {
* will be returned when $new is set to "FALSE."
*
* @access public
- * @param DB_DataSource $source the data source configurations
- * @param boolean $new whether to create a new connection
- * @return DB_Connection the appropriate connection
+ * @param DB_DataSource $source the data source configurations
+ * @param boolean $new whether to create a new connection
+ * @return DB_Connection the appropriate connection
+ * @throws Kohana_Database_Exception indicates that no new connections
+ * can be added
*/
public function get_connection($source = 'default', $new = FALSE) {
if ( ! (is_object($source) && ($source instanceof DB_DataSource))) {
@@ -262,7 +266,7 @@ public static function autorelease() {
*
* @access public
* @static
- * @return DB_Connection_Pool a singleton instance of this class
+ * @return DB_Connection_Pool a singleton instance of this class
*/
public static function instance() {
if (is_null(self::$instance)) {

0 comments on commit e84372b

Please sign in to comment.