[geeklog-cvs] geeklog: phpDocumentor doesn't support @note
geeklog-cvs at lists.geeklog.net
geeklog-cvs at lists.geeklog.net
Sat Mar 7 18:19:46 EST 2009
details: http://project.geeklog.net/cgi-bin/hgweb.cgi/rev/0d2f96565eb5
changeset: 6826:0d2f96565eb5
user: Dirk Haun <dirk at haun-online.de>
date: Sat Mar 07 22:12:04 2009 +0100
description:
phpDocumentor doesn't support @note
diffstat:
12 files changed, 81 insertions(+), 67 deletions(-)
public_html/admin/configuration.php | 10 +---
public_html/admin/database.php | 3 -
public_html/admin/install/lib-install.php | 13 ++++-
public_html/admin/install/lib-upgrade.php | 6 +-
public_html/admin/sectest.php | 12 ++---
public_html/lib-common.php | 64 ++++++++++++++++-------------
public_html/usersettings.php | 6 +-
system/classes/upload.class.php | 7 +--
system/lib-pingback.php | 5 --
system/lib-plugins.php | 11 ++--
system/lib-security.php | 3 -
system/lib-user.php | 8 +--
diffs (truncated from 527 to 300 lines):
diff -r 7b950db79edb -r 0d2f96565eb5 public_html/admin/configuration.php
--- a/public_html/admin/configuration.php Sat Mar 07 19:31:50 2009 +0100
+++ b/public_html/admin/configuration.php Sat Mar 07 22:12:04 2009 +0100
@@ -28,8 +28,6 @@
// | Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
// | |
// +---------------------------------------------------------------------------+
-//
-// $Id: configuration.php,v 1.13 2008/05/03 15:09:13 mjervis Exp $
require_once '../lib-common.php';
require_once 'auth.inc.php';
@@ -41,9 +39,9 @@
/**
* Helper function: Provide language dropdown
*
+* NOTE: Note that key/value are being swapped!
+*
* @return Array Array of (filename, displayname) pairs
-*
-* @note Note that key/value are being swapped!
*
*/
function configmanager_select_language_helper()
@@ -56,9 +54,9 @@
/**
* Helper function: Provide themes dropdown
*
+* NOTE: Beautifying code duplicated from usersettings.php
+*
* @return Array Array of (filename, displayname) pairs
-*
-* @note Beautifying code duplicated from usersettings.php
*
*/
function configmanager_select_theme_helper()
diff -r 7b950db79edb -r 0d2f96565eb5 public_html/admin/database.php
--- a/public_html/admin/database.php Sat Mar 07 19:31:50 2009 +0100
+++ b/public_html/admin/database.php Sat Mar 07 22:12:04 2009 +0100
@@ -239,9 +239,10 @@
/**
* Download a backup file
*
+* NOTE: Filename should have been sanitized and checked before calling this.
+*
* @param string $file Filename (without the path)
* @return void
-* @note Filename should have been sanitized and checked before calling this.
*
*/
function downloadbackup($file)
diff -r 7b950db79edb -r 0d2f96565eb5 public_html/admin/install/lib-install.php
--- a/public_html/admin/install/lib-install.php Sat Mar 07 19:31:50 2009 +0100
+++ b/public_html/admin/install/lib-install.php Sat Mar 07 22:12:04 2009 +0100
@@ -328,10 +328,12 @@
/**
* Written to aid in install script development
*
+ * NOTE: This code is a modified copy from PHP.net
+ *
* @param int $size Filesize
* @param int $dec_places Number of decimal places
* @return string Filesize string
- * @note This code is a modified copy from PHP.net
+ *
*/
function INST_formatSize($size, $dec_places = 0)
{
@@ -360,9 +362,10 @@
/**
* Make a nice display name from the language filename
*
+ * NOTE: This code is a straight copy from MBYTE_languageList()
+ *
* @param string $file filename without the extension
* @return string language name to display to the user
- * @note This code is a straight copy from MBYTE_languageList()
*
*/
function INST_prettifyLanguageName($filename)
@@ -505,9 +508,10 @@
/**
* Check if URL exists
*
+ * 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
- * @note This code is a modified copy from marufit at gmail dot com
*
*/
function INST_urlExists($url)
@@ -633,10 +637,11 @@
* If we're doing an upgrade from 1.5.0 or later and we have the necessary
* DB credentials, skip the forms and upgrade directly.
*
+ * NOTE: Will not return if upgrading from 1.5.0 or later.
+ *
* @param string $dbconfig_path path to db-config.php
* @param string $siteconfig_path path to siteconfig.php
* @return string database version, if possible
- * @note Will not return if upgrading from 1.5.0 or later.
*
*/
function INST_checkPost150Upgrade($dbconfig_path, $siteconfig_path)
diff -r 7b950db79edb -r 0d2f96565eb5 public_html/admin/install/lib-upgrade.php
--- a/public_html/admin/install/lib-upgrade.php Sat Mar 07 19:31:50 2009 +0100
+++ b/public_html/admin/install/lib-upgrade.php Sat Mar 07 22:12:04 2009 +0100
@@ -593,10 +593,11 @@
/**
* Change default character set to UTF-8
*
+* NOTE: Yes, this means that we need to patch siteconfig.php a second time.
+*
* @param string $siteconfig_path complete path to siteconfig.php
* @param string $charset default character set to use
* @return boolean true: success; false: an error occured
-* @note Yes, this means that we need to patch siteconfig.php a second time.
*
*/
function INST_setDefaultCharset($siteconfig_path, $charset)
@@ -782,8 +783,9 @@
/**
* Upgrade any enabled plugins
*
-* @note Needs a fully working Geeklog, so can only be done late in the upgrade
+* NOTE: Needs a fully working Geeklog, so can only be done late in the upgrade
* process!
+*
* @return int number of failed plugin updates (0 = everything's fine)
*
*/
diff -r 7b950db79edb -r 0d2f96565eb5 public_html/admin/sectest.php
--- a/public_html/admin/sectest.php Sat Mar 07 19:31:50 2009 +0100
+++ b/public_html/admin/sectest.php Sat Mar 07 22:12:04 2009 +0100
@@ -29,8 +29,6 @@
// | Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
// | |
// +---------------------------------------------------------------------------+
-//
-// $Id: sectest.php,v 1.13 2007/12/09 18:05:39 dhaun Exp $
require_once '../lib-common.php';
require_once 'auth.inc.php';
@@ -193,9 +191,9 @@
/**
* Check for the existence of the install directory
*
+* NOTE: This test used to be part of the "Get Bent" block in lib-custom.php
+*
* @return string text explaining the result of the test
-*
-* @note This test used to be part of the "Get Bent" block in lib-custom.php
*
*/
function checkInstallDir ()
@@ -233,10 +231,10 @@
/**
* Check for accounts that still use the default password
*
+* NOTE: If one of our users is also using "password" as their password, this
+* test will also detect that, as it checks all accounts.
+*
* @return string text explaining the result of the test
-*
-* @note If one of our users is also using "password" as their password, this
-* test will also detect that, as it checks all accounts.
*
*/
function checkDefaultPassword ()
diff -r 7b950db79edb -r 0d2f96565eb5 public_html/lib-common.php
--- a/public_html/lib-common.php Sat Mar 07 19:31:50 2009 +0100
+++ b/public_html/lib-common.php Sat Mar 07 22:12:04 2009 +0100
@@ -1772,13 +1772,13 @@
* of an article with a future publish date reaching it's
* publish time and if so updates the RDF file.
*
+* NOTE: When called without parameters, this will only check for new entries to
+* include in the feeds. Pass the $updated_XXX parameters when the content
+* of an existing entry has changed.
+*
* @param string $updated_type (optional) feed type to update
* @param string $updated_topic (optional) feed topic to update
* @param string $updated_id (optional) feed id to update
-*
-* @note When called without parameters, this will only check for new entries to
-* include in the feeds. Pass the $updated_XXX parameters when the content
-* of an existing entry has changed.
*
* @see file lib-syndication.php
*
@@ -2718,10 +2718,11 @@
* This function does a redirect using a meta refresh. This is (or at least
* used to be) more compatible than using a HTTP Location: header.
*
+* NOTE: This does not need to be XHTML compliant. It may also be used
+* in situations where the XHTML constant is not defined yet ...
+*
* @param string $url URL to send user to
* @return string HTML meta redirect
-* @note This does not need to be XHTML compliant. It may also be used
-* in situations where the XHTML constant is not defined yet ...
*
*/
function COM_refresh($url)
@@ -2731,11 +2732,14 @@
/**
* DEPRECIATED -- see CMT_userComments in lib-comment.php
+ * @deprecated since Geeklog 1.4.0
*/
-function COM_userComments( $sid, $title, $type='article', $order='', $mode='', $pid = 0, $page = 1, $cid = false, $delete_option = false ) {
+function COM_userComments( $sid, $title, $type='article', $order='', $mode='', $pid = 0, $page = 1, $cid = false, $delete_option = false )
+{
global $_CONF;
require_once $_CONF['path_system'] . 'lib-comment.php';
+
return CMT_userComments( $sid, $title, $type, $order, $mode, $pid, $page, $cid, $delete_option );
}
@@ -3001,7 +3005,6 @@
* @return string $sid Story ID
*
*/
-
function COM_makesid()
{
$sid = date( 'YmdHis' );
@@ -3101,6 +3104,9 @@
* Send an email.
*
* All emails sent by Geeklog are sent through this function now.
+*
+* NOTE: Please note that using the $cc parameter will expose the email addresses
+* of all recipients. Use with care.
*
* @param string $to recipients name and email address
* @param string $subject subject of the email
@@ -3110,9 +3116,6 @@
* @param int $priority (optional) add X-Priority header, if > 0
* @param string $cc (optional) other recipients (name + email)
* @return boolean true if successful, otherwise false
-*
-* @note Please note that using the $cc parameter will expose the email addresses
-* of all recipients. Use with care.
*
*/
function COM_mail( $to, $subject, $message, $from = '', $html = false, $priority = 0, $cc = '' )
@@ -5489,6 +5492,7 @@
* @param string $parameter the parameter to test
* @param boolean $isnumeric true if $parameter is supposed to be numeric
* @return string the filtered parameter (may now be empty or 0)
+* @see COM_applyBasicFilter
*
*/
function COM_applyFilter( $parameter, $isnumeric = false )
@@ -5500,13 +5504,14 @@
/**
* Filter parameters
+*
+* NOTE: Use this function instead of COM_applyFilter for parameters
+* _not_ coming in through a GET or POST request.
*
* @param string $parameter the parameter to test
* @param boolean $isnumeric true if $parameter is supposed to be numeric
* @return string the filtered parameter (may now be empty or 0)
-*
-* @note Use this function instead of COM_applyFilter for parameters
-* _not_ coming in through a GET or POST request.
+* @see COM_applyFilter
*
*/
function COM_applyBasicFilter( $parameter, $isnumeric = false )
@@ -5635,11 +5640,12 @@
/**
* Sanitize a filename.
*
+* NOTE: This function is pretty strict in what it allows. Meant to be used
+* for files to be included where part of the filename is dynamic.
+*
* @param string $filename the filename to clean up
* @param boolean $allow_dots whether to allow dots in the filename or not
* @return string sanitized filename
-* @note This function is pretty strict in what it allows. Meant to be used
-* for files to be included where part of the filename is dynamic.
*
*/
function COM_sanitizeFilename($filename, $allow_dots = false)
@@ -5968,6 +5974,7 @@
* the inverted return values, it has been deprecated and is only provided for
* backward compatibility - use COM_onFrontpage() instead.
*
+* @deprecated since Geeklog 1.4.1
* @see COM_onFrontpage
*
*/
@@ -5976,11 +5983,13 @@
return !COM_onFrontpage();
More information about the geeklog-cvs
mailing list