[geeklog-cvs] geeklog: Some minor corrections in the source code comments
geeklog-cvs at lists.geeklog.net
geeklog-cvs at lists.geeklog.net
Mon Mar 30 07:14:58 EDT 2009
details: http://project.geeklog.net/cgi-bin/hgweb.cgi/rev/f0fc9736cfc6
changeset: 6876:f0fc9736cfc6
user: Dirk Haun <dirk at haun-online.de>
date: Mon Mar 30 13:14:42 2009 +0200
description:
Some minor corrections in the source code comments
diffstat:
3 files changed, 16 insertions(+), 21 deletions(-)
public_html/lib-common.php | 6 ++----
system/classes/downloader.class.php | 25 +++++++++++--------------
system/classes/upload.class.php | 6 +++---
diffs (157 lines):
diff -r be6712ba04de -r f0fc9736cfc6 public_html/lib-common.php
--- a/public_html/lib-common.php Mon Mar 30 10:07:26 2009 +0200
+++ b/public_html/lib-common.php Mon Mar 30 13:14:42 2009 +0200
@@ -2218,7 +2218,7 @@
/**
* Shows the user their menu options
*
-* This shows the average joe use their menu options. This is the user block on right side
+* This shows the average Joe User their menu options. This is the user block on the left side
*
* @param string $help Help file to show
* @param string $title Title of Menu
@@ -2226,7 +2226,6 @@
* @see function COM_adminMenu
*
*/
-
function COM_userMenu( $help='', $title='', $position='' )
{
global $_TABLES, $_USER, $_CONF, $LANG01, $LANG04, $_BLOCK_TEMPLATE;
@@ -2399,7 +2398,7 @@
* Prints administration menu
*
* This will return the administration menu items that the user has
-* sufficient rights to -- Admin Block on right side.
+* sufficient rights to -- Admin Block on the left side.
*
* @param string $help Help file to show
* @param string $title Menu Title
@@ -2407,7 +2406,6 @@
* @see function COM_userMenu
*
*/
-
function COM_adminMenu( $help = '', $title = '', $position = '' )
{
global $_TABLES, $_USER, $_CONF, $LANG01, $_BLOCK_TEMPLATE,
diff -r be6712ba04de -r f0fc9736cfc6 system/classes/downloader.class.php
--- a/system/classes/downloader.class.php Mon Mar 30 10:07:26 2009 +0200
+++ b/system/classes/downloader.class.php Mon Mar 30 13:14:42 2009 +0200
@@ -2,13 +2,13 @@
/* Reminder: always indent with 4 spaces (no tabs). */
// +---------------------------------------------------------------------------+
-// | Geeklog 1.5 |
+// | Geeklog 1.6 |
// +---------------------------------------------------------------------------+
// | downloader.class.php |
// | |
// | Geeklog file download class library. |
// +---------------------------------------------------------------------------+
-// | Copyright (C) 2002-2008 by the following authors: |
+// | Copyright (C) 2002-2009 by the following authors: |
// | |
// | Authors: Tony Bibbs - tony AT tonybibbs DOT com |
// +---------------------------------------------------------------------------+
@@ -28,8 +28,6 @@
// | Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
// | |
// +---------------------------------------------------------------------------+
-//
-// $Id: downloader.class.php,v 1.15 2008/08/11 14:11:21 dhaun Exp $
/**
* This class allows you to download a file from outside the web tree. Many
@@ -104,7 +102,6 @@
$this->_limitByIP = false;
$this->_setAvailableExtensions ();
-
}
// PRIVATE METHODS
@@ -232,11 +229,11 @@
// Public Methods
/**
- * Extra security option that forces all attempts to upload a file to be done
- * so from a set of VERY specific IP's. This is only good for those who are
- * paranoid
+ * Extra security option that forces all attempts to download a file to be
+ * done so from a set of VERY specific IP's. This is only good for those
+ * who are paranoid
*
- * @param $array $validIPS Array of valid IP addresses to allow file uploads from
+ * @param array $validIPS Array of valid IP addresses to allow file uploads from
* @return boolean returns true on success otherwise false
*
*/
@@ -255,8 +252,8 @@
/**
* Sets log file
*
- * @param string $fileName fully qualified path to log files
- * @return boolean true on success otherwise false
+ * @param string $logFile fully qualified path to log files
+ * @return boolean true on success otherwise false
*
*/
function setLogFile($logFile = '')
@@ -360,7 +357,7 @@
}
/**
- * This function will print any debmug messages out.
+ * This function will print any debug messages out.
*
*/
function printDebugMsgs()
@@ -393,7 +390,7 @@
/**
* Sets allowed mime types for this instance
*
- * @param array $allowedMimeTypes Array of allowed mime types
+ * @param array $validExtensions Array of allowed extensions and mime types
*
*/
function setAllowedExtensions($validExtensions = array())
@@ -476,7 +473,7 @@
/**
* Attempts to dowload a file
*
- * @param $string $fileName file to download without path
+ * @param string $fileName file to download without path
* @return boolean true on success otherwise false
*
*/
diff -r be6712ba04de -r f0fc9736cfc6 system/classes/upload.class.php
--- a/system/classes/upload.class.php Mon Mar 30 10:07:26 2009 +0200
+++ b/system/classes/upload.class.php Mon Mar 30 13:14:42 2009 +0200
@@ -756,7 +756,7 @@
}
/**
- * Sets the path to where the mogrify ImageMagic function is
+ * Sets the path to where the mogrify ImageMagick function is
*
* @param string $path_to_mogrify Absolute path to mogrify
* @return boolean True if set, false otherwise
@@ -932,7 +932,7 @@
/**
* Sets log file
*
- * @param string $fileName fully qualified path to log files
+ * @param string $logFile fully qualified path to log files
* @return boolean returns true if we set the log file, otherwise false
*
*/
@@ -1053,7 +1053,7 @@
}
/**
- * This function will print any debmug messages out.
+ * This function will print any debug messages out.
*
*/
function printDebugMsgs()
More information about the geeklog-cvs
mailing list