From ae85eb42aa2d5c6d9a41b3cf6c61a4bf1c9b0566 Mon Sep 17 00:00:00 2001
From: Andrey Andreev <narf@bofh.bg>
Date: Fri, 2 Nov 2012 01:42:31 +0200
Subject: DocBlocks for base DB classes

Partially fixes issue #1295.
---
 system/database/DB.php | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

(limited to 'system/database/DB.php')

diff --git a/system/database/DB.php b/system/database/DB.php
index 676cb9ccd..79e5c7ad2 100644
--- a/system/database/DB.php
+++ b/system/database/DB.php
@@ -32,8 +32,10 @@ defined('BASEPATH') OR exit('No direct script access allowed');
  * @category	Database
  * @author	EllisLab Dev Team
  * @link	http://codeigniter.com/user_guide/database/
- * @param 	string
- * @param 	bool	Determines if query builder should be used or not
+ *
+ * @param 	string|string[]	$params
+ * @param 	bool		$query_builder_override
+ *				Determines if query builder should be used or not
  */
 function &DB($params = '', $query_builder_override = NULL)
 {
@@ -149,11 +151,22 @@ function &DB($params = '', $query_builder_override = NULL)
 		require_once(BASEPATH.'database/DB_query_builder.php');
 		if ( ! class_exists('CI_DB'))
 		{
+			/**
+			 * CI_DB
+			 *
+			 * Acts as an alias for both CI_DB_driver and CI_DB_query_builder.
+			 *
+			 * @see	CI_DB_query_builder
+			 * @see	CI_DB_driver
+			 */
 			class CI_DB extends CI_DB_query_builder { }
 		}
 	}
 	elseif ( ! class_exists('CI_DB'))
 	{
+		/**
+	 	 * @ignore
+		 */
 		class CI_DB extends CI_DB_driver { }
 	}
 
-- 
cgit v1.2.3-24-g4f1b