[geeklog-cvs] geeklog: @param bool -> @param boolean, since "boolean" is used ...
geeklog-cvs at lists.geeklog.net
geeklog-cvs at lists.geeklog.net
Sat Mar 28 12:01:48 EDT 2009
details: http://project.geeklog.net/cgi-bin/hgweb.cgi/rev/7af95656ab91
changeset: 6861:7af95656ab91
user: Dirk Haun <dirk at haun-online.de>
date: Sat Mar 28 16:02:55 2009 +0100
description:
@param bool -> @param boolean, since "boolean" is used more often in the existing code
diffstat:
7 files changed, 30 insertions(+), 27 deletions(-)
public_html/admin/install/lib-install.php | 6 +++---
public_html/directory.php | 11 +++++++----
public_html/lib-common.php | 8 ++++----
system/lib-security.php | 6 +++---
system/lib-syndication.php | 10 +++++-----
system/lib-trackback.php | 8 ++++----
system/lib-user.php | 8 ++++----
diffs (257 lines):
diff -r cd2f21ae7173 -r 7af95656ab91 public_html/admin/install/lib-install.php
--- a/public_html/admin/install/lib-install.php Sat Mar 28 15:55:37 2009 +0100
+++ b/public_html/admin/install/lib-install.php Sat Mar 28 16:02:55 2009 +0100
@@ -111,9 +111,9 @@
/**
* Written to aid in install script debugging, will be removed later
*
- * @param any $var The variable you want to print, can be any datatype
- * @param bool $stop_exec Either echo $var or die $var
- * @return string The datatype and value of $var
+ * @param any $var The variable you want to print, can be any datatype
+ * @param boolean $die_after Either echo $var or die $var
+ * @return string The datatype and value of $var
*
*/
function sanity($var = 'test', $die_after = false)
diff -r cd2f21ae7173 -r 7af95656ab91 public_html/directory.php
--- a/public_html/directory.php Sat Mar 28 15:55:37 2009 +0100
+++ b/public_html/directory.php Sat Mar 28 16:02:55 2009 +0100
@@ -29,6 +29,9 @@
// | |
// +---------------------------------------------------------------------------+
+/**
+* Geeklog common function library
+*/
require_once 'lib-common.php';
// configuration option:
@@ -93,7 +96,7 @@
* @param string $topic current topic
* @param int $year current year
* @param int $month current month
-* @param bool $standalone true: don't display form inline
+* @param boolean $standalone true: don't display form inline
*
*/
function DIR_topicList ($topic = 'all', $year = 0, $month = 0, $standalone = false)
@@ -241,7 +244,7 @@
* @param string $topic current topic
* @param int $year year to display
* @param int $month month to display
-* @param bool $main true: display view on its own page
+* @param boolean $main true: display view on its own page
* @return string list of articles for the given month
*
*/
@@ -316,7 +319,7 @@
*
* @param string $topic current topic
* @param int $year year to display
-* @param bool $main true: display view on its own page
+* @param boolean $main true: display view on its own page
* @return string list of months (+ number of stories) for given year
*
*/
@@ -405,7 +408,7 @@
* the stories for the current month at the top of the page.
*
* @param string $topic current topic
-* @param bool $list_current_month true = list stories f. current month
+* @param boolean $list_current_month true = list stories f. current month
* @return string list of all the years in the db
*
*/
diff -r cd2f21ae7173 -r 7af95656ab91 public_html/lib-common.php
--- a/public_html/lib-common.php Sat Mar 28 15:55:37 2009 +0100
+++ b/public_html/lib-common.php Sat Mar 28 16:02:55 2009 +0100
@@ -525,7 +525,7 @@
* Returns a list of all the directory names in $_CONF['path_themes'], i.e.
* a list of all the theme names.
*
-* @param bool $all if true, return all themes even if users aren't allowed to change their default themes
+* @param boolean $all if true, return all themes even if users aren't allowed to change their default themes
* @return array All installed themes
*
*/
@@ -3511,7 +3511,7 @@
* COM_showBlocks OR from plugin code
*
* @param array $A Block Record
-* @param bool $noboxes Set to true if userpref is no blocks
+* @param boolean $noboxes Set to true if userpref is no blocks
* @return string HTML Formated block
*
*/
@@ -4525,7 +4525,7 @@
* @param int $curpage current page we are on
* @param int $num_pages Total number of pages
* @param string $page_str page-variable name AND '='
-* @param bool $do_rewrite if true, url-rewriting is respected
+* @param boolean $do_rewrite if true, url-rewriting is respected
* @param string $msg to be displayed with the navigation
* @param string $open_ended replace next/last links with this
* @return string HTML formatted widget
@@ -5974,7 +5974,7 @@
*
* See if we're on the main index page (first page, no topics selected).
*
-* @return bool true = we're on the frontpage, false = we're not
+* @return boolean true = we're on the frontpage, false = we're not
*
*/
function COM_onFrontpage()
diff -r cd2f21ae7173 -r 7af95656ab91 system/lib-security.php
--- a/system/lib-security.php Sat Mar 28 15:55:37 2009 +0100
+++ b/system/lib-security.php Sat Mar 28 16:02:55 2009 +0100
@@ -891,7 +891,7 @@
*
* @param string $uid Their user id
* @param string $gname The group name
- * @return bool status, true or false.
+ * @return boolean status, true or false.
*/
function SEC_addUserToGroup($uid, $gname)
{
@@ -970,7 +970,7 @@
* This function can be used by plugins during uninstall.
*
* @param string $feature_name name of the feature, e.g. 'foo.edit'
-* @param bool $logging whether to log progress in error.log
+* @param boolean $logging whether to log progress in error.log
* @return void
*
*/
@@ -1120,7 +1120,7 @@
* Checks the POST and GET data for a security token, if one exists, validates that it's for this
* user and URL.
*
- * @return bool true iff the token is valid and for this user.
+ * @return boolean true if the token is valid and for this user.
*/
function SEC_checkToken()
{
diff -r cd2f21ae7173 -r 7af95656ab91 system/lib-syndication.php
--- a/system/lib-syndication.php Sat Mar 28 15:55:37 2009 +0100
+++ b/system/lib-syndication.php Sat Mar 28 16:02:55 2009 +0100
@@ -44,12 +44,12 @@
/**
* Check if a feed for all stories needs to be updated.
*
-* @param bool $frontpage_only true: only articles shown on the frontpage
+* @param boolean $frontpage_only true: only articles shown on the frontpage
* @param string $update_info list of story ids
* @param string $limit number of entries or number of hours
* @param string $updated_topic (optional) topic to be updated
* @param string $updated_id (optional) entry id to be updated
-* @return bool false = feed needs to be updated
+* @return boolean false = feed needs to be updated
*
*/
function SYND_feedUpdateCheckAll( $frontpage_only, $update_info, $limit, $updated_topic = '', $updated_id = '' )
@@ -129,7 +129,7 @@
* @param string $limit number of entries or number of hours
* @param string $updated_topic (optional) topic to be updated
* @param string $updated_id (optional) entry id to be updated
-* @return bool false = feed needs to be updated
+* @return boolean false = feed needs to be updated
*
*/
function SYND_feedUpdateCheckTopic( $tid, $update_info, $limit, $updated_topic = '', $updated_id = '' )
@@ -187,7 +187,7 @@
* @param string limit number of entries or number of hours
* @param string updated_topic (optional) specific topic to update
* @param string updated_id (optional) specific id to update
-* @return bool false = feed has to be updated, true = ok
+* @return boolean false = feed has to be updated, true = ok
*
*/
function SYND_feedUpdateCheck($topic, $update_data, $limit, $updated_topic = '', $updated_id = '')
@@ -320,7 +320,7 @@
/**
* Get content for a feed that holds all stories.
*
-* @param bool $frontpage_only true: only articles shown on the frontpage
+* @param boolean $frontpage_only true: only articles shown on the frontpage
* @param string $limit number of entries or number of stories
* @param string $link link to homepage
* @param string $update list of story ids
diff -r cd2f21ae7173 -r 7af95656ab91 system/lib-trackback.php
--- a/system/lib-trackback.php Sat Mar 28 15:55:37 2009 +0100
+++ b/system/lib-trackback.php Sat Mar 28 16:02:55 2009 +0100
@@ -195,7 +195,7 @@
*
* @param string $sid ID of the parent object of the comment
* @param string $type type of the parent object ('article' = story, etc.)
-* @return bool true = user can delete the comment, false = nope
+* @return boolean true = user can delete the comment, false = nope
*
*/
function TRB_allowDelete ($sid, $type)
@@ -340,7 +340,7 @@
* @param string $blog name of the blog that sent the comment
* @param string $excerpt excerpt from the comment
* @param timestamp $date date and time when the comment was sent
-* @param bool $delete_option whether to display a link to delete the trackback comment
+* @param boolean $delete_option whether to display a link to delete the trackback comment
* @param string $cid id of this trackback comment
* @param string $ipaddress IP address the comment was sent from
* @param string $token security token
@@ -469,7 +469,7 @@
* @param string $sid ID of entry that got pinged
* @param string $type type of that entry ('article' for stories, etc.)
* @param string $urlToGet URL of the page that supposedly links to us
-* @return bool true = links to us, false = doesn't
+* @return boolean true = links to us, false = doesn't
*
*/
function TRB_linksToUs ($sid, $type, $urlToGet)
@@ -528,7 +528,7 @@
*
* @param string $sid ID of entry that got pinged
* @param string $type type of that entry ('article' for stories, etc.)
-* @return bool true = success, false = an error occured
+* @return boolean true = success, false = an error occured
*
* P.S. "Critical" errors are rejected with a HTTP 403 Forbidden status code.
* According to RFC2616, this status code means
diff -r cd2f21ae7173 -r 7af95656ab91 system/lib-user.php
--- a/system/lib-user.php Sat Mar 28 15:55:37 2009 +0100
+++ b/system/lib-user.php Sat Mar 28 16:02:55 2009 +0100
@@ -133,7 +133,7 @@
*
* @param string $username user's login name
* @param string $useremail user's email address
-* @return bool true = success, false = an error occured
+* @return boolean true = success, false = an error occured
*
*/
function USER_createAndSendPassword ($username, $useremail, $uid)
@@ -188,7 +188,7 @@
*
* @param string $username user's login name
* @param string $useremail user's email address
-* @return bool true = success, false = an error occured
+* @return boolean true = success, false = an error occured
*
*/
function USER_sendActivationEmail ($username, $useremail)
@@ -346,7 +346,7 @@
* @param email string Email address of the new user
* @param uid int User id of the new user
* @param mode string Mode user was added at.
-* @return bool true = success, false = an error occured
+* @return boolean true = success, false = an error occured
*
*/
function USER_sendNotification ($username, $email, $uid, $mode='inactive')
@@ -471,7 +471,7 @@
* NOTE: Will silently ignore non-existing files.
*
* @param string $photo name of the photo (without the path)
-* @param bool $abortonerror true: abort script on error, false: don't
+* @param boolean $abortonerror true: abort script on error, false: don't
* @return void
*
*/
More information about the geeklog-cvs
mailing list