albertlast / SMF2.1

Themes/default/Packages.template.php

Doc Comments +1 added lines, -1 removed lines

@@ -1096,7 +1096,7 @@
 /**
  * CHMOD control form
  *
- * @return bool False if nothing to do.
+ * @return false|null False if nothing to do.
  */
 function template_control_chmod()
 {

Sources/CacheAPI-smf.php

Doc Comments +1 added lines, -1 removed lines

@@ -180,7 +180,7 @@
 	 *
 	 * @access public
 	 * @param string $dir A valid path
-	 * @return boolean If this was successful or not.
+	 * @return boolean|null If this was successful or not.
 	 */
 	public function setCachedir($dir = null)
 	{

other/upgrade-helper.php

Doc Comments +3 added lines, -3 removed lines

@@ -81,7 +81,7 @@ 
 /**
  * Make files writable. First try to use regular chmod, but if that fails, try to use FTP.
  *
- * @param $files
+ * @param string[] $files
  * @return bool
  */
 function makeFilesWritable(&$files)
@@ -322,7 +322,7 @@ 
 /**
  * Prints an error to stderr.
  *
- * @param $message
+ * @param string $message
  * @param bool $fatal
  */
 function print_error($message, $fatal = false)
@@ -341,7 +341,7 @@ 
 /**
  * Throws a graphical error message.
  *
- * @param $message
+ * @param string $message
  * @return bool
  */
 function throw_error($message)

other/upgrade.php

Doc Comments +14 added lines, -1 removed lines

@@ -393,6 +393,9 @@ 
 }
 
 // Used to direct the user to another location.
+/**
+ * @param string $location
+ */
 function redirectLocation($location, $addForm = true)
 {
 	global $upgradeurl, $upcontext, $command_line;
@@ -1573,6 +1576,9 @@ 
 	return addslashes(preg_replace(array('~^\.([/\\\]|$)~', '~[/]+~', '~[\\\]+~', '~[/\\\]$~'), array($install_path . '$1', '/', '\\', ''), $path));
 }
 
+/**
+ * @param string $filename
+ */
 function parse_sql($filename)
 {
 	global $db_prefix, $db_collation, $boarddir, $boardurl, $command_line, $file_steps, $step_progress, $custom_warning;
@@ -1607,6 +1613,10 @@ 
 
 	// Our custom error handler - does nothing but does stop public errors from XML!
 	set_error_handler(
+
+		/**
+		 * @param string $errno
+		 */
 		function ($errno, $errstr, $errfile, $errline) use ($support_js)
 		{
 			if ($support_js)
@@ -1853,6 +1863,9 @@ 
 	return true;
 }
 
+/**
+ * @param string $string
+ */
 function upgrade_query($string, $unbuffered = false)
 {
 	global $db_connection, $db_server, $db_user, $db_passwd, $db_type, $command_line, $upcontext, $upgradeurl, $modSettings;
@@ -4512,7 +4525,7 @@ 
  * @param int $setSize The amount of entries after which to update the database.
  *
  * newCol needs to be a varbinary(16) null able field
- * @return bool
+ * @return boolean|null
  */
 function MySQLConvertOldIp($targetTable, $oldCol, $newCol, $limit = 50000, $setSize = 100)
 {

Sources/News.php

Doc Comments +1 added lines

@@ -540,6 +540,7 @@
  * @param string $xml_format The format to use ('atom', 'rss', 'rss2' or empty for plain XML)
  * @param array $forceCdataKeys A list of keys on which to force cdata wrapping (used by mods, maybe)
  * @param array $nsKeys Key-value pairs of namespace prefixes to pass to cdata_parse() (used by mods, maybe)
+ * @param string $tag
  */
 function dumpTags($data, $i, $tag = null, $xml_format = '', $forceCdataKeys = array(), $nsKeys = array())
 {

Themes/default/Calendar.template.php

Doc Comments +3 added lines, -3 removed lines

@@ -68,7 +68,7 @@ 
  * Display a list of upcoming events, birthdays, and holidays.
  *
  * @param string $grid_name The grid name
- * @return void|bool Returns false if the grid doesn't exist.
+ * @return false|null Returns false if the grid doesn't exist.
  */
 function template_show_upcoming_list($grid_name)
 {
@@ -238,7 +238,7 @@ 
  *
  * @param string $grid_name The grid name
  * @param bool $is_mini Is this a mini grid?
- * @return void|bool Returns false if the grid doesn't exist.
+ * @return false|null Returns false if the grid doesn't exist.
  */
 function template_show_month_grid($grid_name, $is_mini = false)
 {
@@ -523,7 +523,7 @@ 
  * Shows a weekly grid
  *
  * @param string $grid_name The name of the grid
- * @return void|bool Returns false if the grid doesn't exist
+ * @return false|null Returns false if the grid doesn't exist
  */
 function template_show_week_grid($grid_name)
 {

Sources/CacheAPI-sqlite.php

Doc Comments +1 added lines, -1 removed lines

@@ -143,7 +143,7 @@
 	 *
 	 * @param string $dir A valid path
 	 *
-	 * @return boolean If this was successful or not.
+	 * @return boolean|null If this was successful or not.
 	 */
 	public function setCachedir($dir = null)
 	{

Sources/Class-CurlFetchWeb.php

Doc Comments +4 added lines, -4 removed lines

@@ -97,7 +97,7 @@ 
 	* Start the curl object
 	* - allow for user override values
 	*
-	* @param array $options An array of cURL options
+	* @param integer[] $options An array of cURL options
 	* @param int $max_redirect Maximum number of redirects
 	*/
 	public function __construct($options = array(), $max_redirect = 3)
@@ -115,8 +115,8 @@ 
 	*  - calls set_options to set the curl opts array values based on the defaults and user input
 	*
 	* @param string $url the site we are going to fetch
-	* @param array $post_data any post data as form name => value
-	* @return object An instance of the curl_fetch_web_data class
+	* @param string $post_data any post data as form name => value
+	* @return curl_fetch_web_data An instance of the curl_fetch_web_data class
 	*/
 	public function get_url_data($url, $post_data = array())
 	{
@@ -140,7 +140,7 @@ 
 	*
 	* @param string $url The site to fetch
 	* @param bool $redirect Whether or not this was a redirect request
-	* @return void|bool Sets various properties of the class or returns false if the URL isn't specified
+	* @return false|null Sets various properties of the class or returns false if the URL isn't specified
 	*/
 	private function curl_request($url, $redirect = false)
 	{

Sources/DbPackages-postgresql.php

Doc Comments +1 added lines, -1 removed lines

@@ -382,7 +382,7 @@
  * @param array $parameters Not used?
  * @param string $if_exists What to do if the index exists. If 'update', the definition will be updated.
  * @param string $error
- * @return boolean Whether or not the operation was successful
+ * @return false|null Whether or not the operation was successful
  */
 function smf_db_add_index($table_name, $index_info, $parameters = array(), $if_exists = 'update', $error = 'fatal')
 {