[geeklog-cvs] geeklog: Documentation cleanup: bool -> boolean
geeklog-cvs at lists.geeklog.net
geeklog-cvs at lists.geeklog.net
Sun Feb 21 14:53:32 EST 2010
changeset 7744:afd1a198bfd9
url: http://project.geeklog.net/cgi-bin/hgwebdir.cgi/geeklog/rev/afd1a198bfd9
user: Dirk Haun <dirk at haun-online.de>
date: Sat Feb 20 22:38:40 2010 +0100
description:
Documentation cleanup: bool -> boolean
diffstat:
plugins/polls/functions.inc | 2 +-
plugins/staticpages/functions.inc | 2 +-
public_html/admin/database.php | 2 +-
public_html/admin/install/lib-install.php | 10 +++++-----
public_html/pingback.php | 2 +-
public_html/usersettings.php | 2 +-
system/classes/unpacker.class.php | 20 ++++++++++----------
system/classes/upload.class.php | 2 +-
system/lib-comment.php | 2 +-
system/lib-security.php | 2 +-
system/lib-story.php | 2 +-
11 files changed, 24 insertions(+), 24 deletions(-)
diffs (249 lines):
diff -r ab9277207ba9 -r afd1a198bfd9 plugins/polls/functions.inc
--- a/plugins/polls/functions.inc Sat Feb 20 21:49:42 2010 +0100
+++ b/plugins/polls/functions.inc Sat Feb 20 22:38:40 2010 +0100
@@ -623,7 +623,7 @@
*
* @param int $size Size in pixels of poll results
* @param string $pid Poll topic ID to show (optional)
-* @param bool $showall Show only the first question or all
+* @param boolean $showall Show only the first question or all
* @param int $displaytype Possible values 0 = Normal, 1 = In Block, 2 = autotag
* @return string HTML formatted string of poll
* @see function COM_pollVote
diff -r ab9277207ba9 -r afd1a198bfd9 plugins/staticpages/functions.inc
--- a/plugins/staticpages/functions.inc Sat Feb 20 21:49:42 2010 +0100
+++ b/plugins/staticpages/functions.inc Sat Feb 20 22:38:40 2010 +0100
@@ -1454,7 +1454,7 @@
/**
* Return true since this plugin supports webservices
*
- * @return bool True, if webservices are supported
+ * @return boolean True, if webservices are supported
*/
function plugin_wsEnabled_staticpages()
{
diff -r ab9277207ba9 -r afd1a198bfd9 public_html/admin/database.php
--- a/public_html/admin/database.php Sat Feb 20 21:49:42 2010 +0100
+++ b/public_html/admin/database.php Sat Feb 20 22:38:40 2010 +0100
@@ -395,7 +395,7 @@
/**
* Check if all the tables have already been converted to InnoDB
*
-* @return bool true: all tables are InnoDB, otherwise false
+* @return boolean true: all tables are InnoDB, otherwise false
*
*/
function already_converted()
diff -r ab9277207ba9 -r afd1a198bfd9 public_html/admin/install/lib-install.php
--- a/public_html/admin/install/lib-install.php Sat Feb 20 21:49:42 2010 +0100
+++ b/public_html/admin/install/lib-install.php Sat Feb 20 22:38:40 2010 +0100
@@ -221,7 +221,7 @@
/**
* Check if the user's PHP version is supported by Geeklog
*
- * @return bool True if supported, falsed if not supported
+ * @return boolean True if supported, falsed if not supported
*
*/
function INST_phpOutOfDate()
@@ -272,7 +272,7 @@
* Check if the user's MySQL version is supported by Geeklog
*
* @param array $db Database information
- * @return bool True if supported, falsed if not supported
+ * @return boolean True if supported, falsed if not supported
*
*/
function INST_mysqlOutOfDate($db)
@@ -367,7 +367,7 @@
*
* @param string $config_file Full path to db-config.php
* @param array $db Database information to save
- * @return bool True if successful, false if not
+ * @return boolean True if successful, false if not
*
*/
function INST_writeConfig($config_file, $db)
@@ -464,7 +464,7 @@
* Check if a Geeklog database exists
*
* @param array $db Array containing connection info
- * @return bool True if a database exists, false if not
+ * @return boolean True if a database exists, false if not
*
*/
function INST_dbExists($db)
@@ -498,7 +498,7 @@
* NOTE: This code is a modified copy from marufit at gmail dot com
*
* @param string $url URL
- * @return bool True if URL exists, false if not
+ * @return boolean True if URL exists, false if not
*
*/
function INST_urlExists($url)
diff -r ab9277207ba9 -r afd1a198bfd9 public_html/pingback.php
--- a/public_html/pingback.php Sat Feb 20 21:49:42 2010 +0100
+++ b/public_html/pingback.php Sat Feb 20 22:38:40 2010 +0100
@@ -227,7 +227,7 @@
* Check if the targetURI really points to us
*
* @param string $url targetURI, a URL on our site
-* @return bool true = is a URL on our site
+* @return boolean true = is a URL on our site
*
*/
function PNB_validURL ($url)
diff -r ab9277207ba9 -r afd1a198bfd9 public_html/usersettings.php
--- a/public_html/usersettings.php Sat Feb 20 21:49:42 2010 +0100
+++ b/public_html/usersettings.php Sat Feb 20 22:38:40 2010 +0100
@@ -699,7 +699,7 @@
*
* @param email string email address to check
* @param uid int user id of current user
-* @return bool true = exists, false = does not exist
+* @return boolean true = exists, false = does not exist
*
*/
function emailAddressExists ($email, $uid)
diff -r ab9277207ba9 -r afd1a198bfd9 system/classes/unpacker.class.php
--- a/system/classes/unpacker.class.php Sat Feb 20 21:49:42 2010 +0100
+++ b/system/classes/unpacker.class.php Sat Feb 20 22:38:40 2010 +0100
@@ -75,7 +75,7 @@
*
* @param string $file full path to archive
* @param string $mime_type mime type ( optional, application/zip, /tar, etc )
- * @return bool $success result of loading archive passed
+ * @return boolean $success result of loading archive passed
*/
function unpacker($file, $mime_type = null) {
@@ -145,7 +145,7 @@
*
* @param string $file full path to archive
* @param string $optional_type mime type ( application/zip, /tar, etc )
- * @return bool $success result of loading archive passed
+ * @return boolean $success result of loading archive passed
*/
function open($file, $optional_type = false) {
@@ -166,7 +166,7 @@
*
* Decides which loader to call, or returns false if one isn't found.
*
- * @return bool $success result of loading archive passed
+ * @return boolean $success result of loading archive passed
*/
function load_file() {
@@ -181,7 +181,7 @@
/**
* load a zip archive
*
- * @return bool $success result of loading archive passed
+ * @return boolean $success result of loading archive passed
*/
function load_zip() {
@@ -210,7 +210,7 @@
/**
* load a tar archive
*
- * @return bool $success result of loading archive passed
+ * @return boolean $success result of loading archive passed
*/
function load_tar() {
@@ -309,7 +309,7 @@
*
* @param string $target_path destination
* @param array $item_array array of specific path/file(s)
- * @return bool result
+ * @return boolean result
*/
function unpack($target_path, $item_array = null) {
@@ -336,7 +336,7 @@
*
* @param string $target_path destination
* @param array $item_array array of specific path/file(s)
- * @return bool result
+ * @return boolean result
*/
function unpack_zip($target_path, $item_array = null) {
@@ -395,7 +395,7 @@
*
* @param string $target_path destination
* @param array $item_array array of specific path/file(s)
- * @return bool result
+ * @return boolean result
*/
function unpack_tar($target_path, $item_array = null) {
@@ -413,7 +413,7 @@
/**
* return the first directory name in the archive
*
- * @return mixed string directory name, or bool false
+ * @return mixed string directory name, or boolean false
*/
function getdir() {
@@ -460,7 +460,7 @@
*
* @param string $errorno error number ( anything goes )
* @param string $error error text ( anything goes )
- * @return bool, always false
+ * @return boolean, always false
*/
function setError($errorno, $error) {
diff -r ab9277207ba9 -r afd1a198bfd9 system/classes/upload.class.php
--- a/system/classes/upload.class.php Sat Feb 20 21:49:42 2010 +0100
+++ b/system/classes/upload.class.php Sat Feb 20 22:38:40 2010 +0100
@@ -435,7 +435,7 @@
*
* @access private
* @param string $filename name of uploaded file
- * @return bool true: okay, false: an error occured
+ * @return boolean true: okay, false: an error occured
*
*/
function _keepOriginalFile ($filename)
diff -r ab9277207ba9 -r afd1a198bfd9 system/lib-comment.php
--- a/system/lib-comment.php Sat Feb 20 21:49:42 2010 +0100
+++ b/system/lib-comment.php Sat Feb 20 22:38:40 2010 +0100
@@ -1593,7 +1593,7 @@
* @param string $comment comment text
* @param string $postmode ('html', 'plaintext', ...)
* @param string $type Type of item (article, polls, etc.)
- * @param bool $edit if true append edit tag
+ * @param boolean $edit if true append edit tag
* @param int $cid commentid if editing comment (for proper sig)
* @return string of comment text
*/
diff -r ab9277207ba9 -r afd1a198bfd9 system/lib-security.php
--- a/system/lib-security.php Sat Feb 20 21:49:42 2010 +0100
+++ b/system/lib-security.php Sat Feb 20 22:38:40 2010 +0100
@@ -1447,7 +1447,7 @@
* @param int $expire expire time
* @param string $path path on the server or $_CONF['cookie_path']
* @param string $domain domain or $_CONF['cookiedomain']
-* @param bool $secure whether to use HTTPS or $_CONF['cookiesecure']
+* @param boolean $secure whether to use HTTPS or $_CONF['cookiesecure']
* @link http://blog.mattmecham.com/2006/09/12/http-only-cookies-without-php-52/
*
*/
diff -r ab9277207ba9 -r afd1a198bfd9 system/lib-story.php
--- a/system/lib-story.php Sat Feb 20 21:49:42 2010 +0100
+++ b/system/lib-story.php Sat Feb 20 22:38:40 2010 +0100
@@ -906,7 +906,7 @@
/**
* Return true since this component supports webservices
*
-* @return bool True, if webservices are supported
+* @return boolean True, if webservices are supported
*
*/
function plugin_wsEnabled_story()
More information about the geeklog-cvs
mailing list