ci-bonfire / Sprint

system/core/Config.php

Doc Comments +1 added lines, -1 removed lines

@@ -121,7 +121,7 @@
 	 * @param	string	$file			Configuration file name
 	 * @param	bool	$use_sections		Whether configuration values should be loaded into their own section
 	 * @param	bool	$fail_gracefully	Whether to just return FALSE or display an error message
-	 * @return	bool	TRUE if the file was loaded correctly or FALSE on failure
+	 * @return	boolean|null	TRUE if the file was loaded correctly or FALSE on failure
 	 */
 	public function load($file = '', $use_sections = FALSE, $fail_gracefully = FALSE)
 	{

system/core/Exceptions.php

Doc Comments +1 added lines, -1 removed lines

@@ -148,7 +148,7 @@
 	 * and displays it using the specified template.
 	 *
 	 * @param	string		$heading	Page heading
-	 * @param	string|string[]	$message	Error message
+	 * @param	string	$message	Error message
 	 * @param	string		$template	Template name
 	 * @param 	int		$status_code	(default: 500)
 	 *

system/core/Hooks.php

Doc Comments +1 added lines, -1 removed lines

@@ -160,7 +160,7 @@
 	 * Runs a particular hook
 	 *
 	 * @param	array	$data	Hook details
-	 * @return	bool	TRUE on success or FALSE on failure
+	 * @return	boolean|null	TRUE on success or FALSE on failure
 	 */
 	protected function _run_hook($data)
 	{

system/core/Input.php

Doc Comments +5 added lines, -5 removed lines

@@ -233,7 +233,7 @@ 
 	/**
 	 * Fetch an item from the GET array
 	 *
-	 * @param	mixed	$index		Index for item to be fetched from $_GET
+	 * @param	string	$index		Index for item to be fetched from $_GET
 	 * @param	bool	$xss_clean	Whether to apply XSS filtering
 	 * @return	mixed
 	 */
@@ -247,7 +247,7 @@ 
 	/**
 	 * Fetch an item from the POST array
 	 *
-	 * @param	mixed	$index		Index for item to be fetched from $_POST
+	 * @param	string	$index		Index for item to be fetched from $_POST
 	 * @param	bool	$xss_clean	Whether to apply XSS filtering
 	 * @return	mixed
 	 */
@@ -307,9 +307,9 @@ 
 	/**
 	 * Fetch an item from the SERVER array
 	 *
-	 * @param	mixed	$index		Index for item to be fetched from $_SERVER
+	 * @param	string	$index		Index for item to be fetched from $_SERVER
 	 * @param	bool	$xss_clean	Whether to apply XSS filtering
-	 * @return	mixed
+	 * @return	string
 	 */
 	public function server($index, $xss_clean = NULL)
 	{
@@ -877,7 +877,7 @@ 
 	 * Allows read access to protected properties
 	 *
 	 * @param	string	$name
-	 * @return	mixed
+	 * @return	string|null
 	 */
 	public function __get($name)
 	{

system/core/Loader.php

Doc Comments +10 added lines, -10 removed lines

@@ -185,7 +185,7 @@ 
 	 * @param	string	$library	Library name
 	 * @param	array	$params		Optional parameters to pass to the library class constructor
 	 * @param	string	$object_name	An optional object name to assign to
-	 * @return	object
+	 * @return	CI_Loader
 	 */
 	public function library($library, $params = NULL, $object_name = NULL)
 	{
@@ -229,7 +229,7 @@ 
 	 * @param	string	$model		Model name
 	 * @param	string	$name		An optional object name to assign to
 	 * @param	bool	$db_conn	An optional database connection configuration to initialize
-	 * @return	object
+	 * @return	CI_Loader
 	 */
 	public function model($model, $name = '', $db_conn = FALSE)
 	{
@@ -329,7 +329,7 @@ 
 	/**
 	 * Database Loader
 	 *
-	 * @param	mixed	$params		Database configuration options
+	 * @param	string|boolean	$params		Database configuration options
 	 * @param	bool	$return 	Whether to return the database object
 	 * @param	bool	$query_builder	Whether to enable Query Builder
 	 *					(overrides the configuration setting)
@@ -485,7 +485,7 @@ 
 	 *					An associative array or object containing values
 	 *					to be set, or a value's name if string
 	 * @param 	string	$val	Value to set, only used if $vars is a string
-	 * @return	object
+	 * @return	CI_Loader
 	 */
 	public function vars($vars, $val = '')
 	{
@@ -557,7 +557,7 @@ 
 	 * Helper Loader
 	 *
 	 * @param	string|string[]	$helpers	Helper name(s)
-	 * @return	object
+	 * @return	CI_Loader
 	 */
 	public function helper($helpers = array())
 	{
@@ -628,7 +628,7 @@ 
 	 *
 	 * @uses	CI_Loader::helper()
 	 * @param	string|string[]	$helpers	Helper name(s)
-	 * @return	object
+	 * @return	CI_Loader
 	 */
 	public function helpers($helpers = array())
 	{
@@ -644,7 +644,7 @@ 
 	 *
 	 * @param	string|string[]	$files	List of language file names to load
 	 * @param	string		Language name
-	 * @return	object
+	 * @return	CI_Loader
 	 */
 	public function language($files, $lang = '')
 	{
@@ -731,7 +731,7 @@ 
 	 *
 	 * @param	string	$path		Path to add
 	 * @param 	bool	$view_cascade	(default: TRUE)
-	 * @return	object
+	 * @return	CI_Loader
 	 */
 	public function add_package_path($path, $view_cascade = TRUE)
 	{
@@ -775,7 +775,7 @@ 
 	 * added path will be removed removed.
 	 *
 	 * @param	string	$path	Path to remove
-	 * @return	object
+	 * @return	CI_Loader
 	 */
 	public function remove_package_path($path = '')
 	{
@@ -1061,7 +1061,7 @@ 
 	 * @used-by	CI_Loader::_ci_load_library()
 	 * @uses	CI_Loader::_ci_init_library()
 	 *
-	 * @param	string	$library	Library name to load
+	 * @param	string	$library_name	Library name to load
 	 * @param	string	$file_path	Path to the library filename, relative to libraries/
 	 * @param	mixed	$params		Optional parameters to pass to the class constructor
 	 * @param	string	$object_name	Optional object name to assign to

system/core/Output.php

Doc Comments +1 added lines, -1 removed lines

@@ -285,7 +285,7 @@
 	/**
 	 * Get Header
 	 *
-	 * @param	string	$header_name
+	 * @param	string	$header
 	 * @return	string
 	 */
 	public function get_header($header)

system/database/DB_cache.php

Doc Comments +1 added lines

@@ -69,6 +69,7 @@
 	 * Constructor
 	 *
 	 * @param	object	&$db
+	 * @param CI_DB_driver $db
 	 * @return	void
 	 */
 	public function __construct(&$db)

system/database/DB_driver.php

Doc Comments +8 added lines, -2 removed lines

@@ -451,7 +451,7 @@ 
 	 *
 	 * This is just a dummy method that all drivers will override.
 	 *
-	 * @return	mixed
+	 * @return	boolean
 	 */
 	public function db_connect()
 	{
@@ -463,7 +463,7 @@ 
 	/**
 	 * Persistent database connection
 	 *
-	 * @return	mixed
+	 * @return	boolean
 	 */
 	public function db_pconnect()
 	{
@@ -508,6 +508,7 @@ 
 	 * Set client character set
 	 *
 	 * @param	string
+	 * @param string $charset
 	 * @return	bool
 	 */
 	public function db_set_charset($charset)
@@ -768,6 +769,7 @@ 
 	 * not require all the features of the main query() function.
 	 *
 	 * @param	string	the sql query
+	 * @param string $sql
 	 * @return	mixed
 	 */
 	public function simple_query($sql)
@@ -968,6 +970,7 @@ 
 	 *
 	 * @param	string	the sql statement
 	 * @param	array	an array of bind data
+	 * @param string $sql
 	 * @return	string
 	 */
 	public function compile_binds($sql, $binds)
@@ -1032,6 +1035,7 @@ 
 	 * Determines if a query is a "write" type.
 	 *
 	 * @param	string	An SQL query string
+	 * @param string $sql
 	 * @return	bool
 	 */
 	public function is_write_type($sql)
@@ -1168,6 +1172,7 @@ 
 	 * Platform-dependant string escape
 	 *
 	 * @param	string
+	 * @param string $str
 	 * @return	string
 	 */
 	protected function _escape_str($str)
@@ -1461,6 +1466,7 @@ 
 	 * @param	string	the table name
 	 * @param	array	the insert keys
 	 * @param	array	the insert values
+	 * @param string $table
 	 * @return	string
 	 */
 	protected function _insert($table, $keys, $values)

system/database/DB_forge.php

Doc Comments +1 added lines, -1 removed lines

@@ -372,7 +372,7 @@
 	 * @param	string	$table		Table name
 	 * @param	bool	$if_not_exists	Whether to add 'IF NOT EXISTS' condition
 	 * @param	array	$attributes	Associative array of table attributes
-	 * @return	mixed
+	 * @return	boolean|string
 	 */
 	protected function _create_table($table, $if_not_exists, $attributes)
 	{