[geeklog-cvs] geeklog: Fixed phpDocumentor warnings

[geeklog-cvs at lists.geeklog.net]

details:   http://project.geeklog.net/cgi-bin/hgweb.cgi/rev/e0c7423ea657
changeset: 6862:e0c7423ea657
user:      Dirk Haun <dirk at haun-online.de>
date:      Sat Mar 28 17:00:42 2009 +0100
description:
Fixed phpDocumentor warnings

diffstat:

8 files changed, 40 insertions(+), 15 deletions(-)
plugins/links/functions.inc          |    7 +++++--
plugins/polls/functions.inc          |    7 +++++--
plugins/spamx/functions.inc          |    2 +-
plugins/staticpages/functions.inc    |    7 +++++--
plugins/staticpages/services.inc.php |    5 ++++-
public_html/lib-common.php           |   21 ++++++++++++++-------
public_html/polls/index.php          |    3 +++
public_html/staticpages/index.php    |    3 +++

diffs (188 lines):

diff -r 7af95656ab91 -r e0c7423ea657 plugins/links/functions.inc
--- a/plugins/links/functions.inc	Sat Mar 28 16:02:55 2009 +0100
+++ b/plugins/links/functions.inc	Sat Mar 28 17:00:42 2009 +0100
@@ -47,15 +47,18 @@
 }
 
 $plugin_path = $_CONF['path'] . 'plugins/links/';
+
+/**
+* Language file include
+*/
 $langfile = $plugin_path . 'language/' . $_CONF['language'] . '.php';
-
 if (file_exists($langfile)) {
     require_once $langfile;
 } else {
     require_once $plugin_path . 'language/english.php';
 }
 
-/*
+/**
 * Check and see if we need to load the plugin configuration
 */
 if (!isset($_LI_CONF['linksloginrequired'])) {
diff -r 7af95656ab91 -r e0c7423ea657 plugins/polls/functions.inc
--- a/plugins/polls/functions.inc	Sat Mar 28 16:02:55 2009 +0100
+++ b/plugins/polls/functions.inc	Sat Mar 28 17:00:42 2009 +0100
@@ -45,15 +45,18 @@
 }
 
 $plugin_path = $_CONF['path'] . 'plugins/polls/';
+
+/**
+* Language file include
+*/
 $langfile = $plugin_path . 'language/' . $_CONF['language'] . '.php';
-
 if (file_exists($langfile)) {
     require_once $langfile;
 } else {
     require_once $plugin_path . 'language/english.php';
 }
 
-/*
+/**
 * Check and see if we need to load the plugin configuration
 */ 
 if (!isset($_PO_CONF['pollsloginrequired'])) {
diff -r 7af95656ab91 -r e0c7423ea657 plugins/spamx/functions.inc
--- a/plugins/spamx/functions.inc	Sat Mar 28 16:02:55 2009 +0100
+++ b/plugins/spamx/functions.inc	Sat Mar 28 17:00:42 2009 +0100
@@ -29,7 +29,7 @@
     include_once $plugin_path . 'language/english.php';
 }
 
-/*
+/**
 * Check and see if we need to load the plugin configuration
 */
 if (!isset($_SPX_CONF['timeout'])) {
diff -r 7af95656ab91 -r e0c7423ea657 plugins/staticpages/functions.inc
--- a/plugins/staticpages/functions.inc	Sat Mar 28 16:02:55 2009 +0100
+++ b/plugins/staticpages/functions.inc	Sat Mar 28 17:00:42 2009 +0100
@@ -45,15 +45,18 @@
 }
 
 $plugin_path = $_CONF['path'] . 'plugins/staticpages/';
+
+/**
+* Language file include
+*/
 $langfile = $plugin_path . 'language/' . $_CONF['language'] . '.php';
-
 if (file_exists($langfile)) {
     require_once $langfile;
 } else {
     require_once $plugin_path . 'language/english.php';
 }
 
-/*
+/**
 * Check and see if we need to load the plugin configuration
 */
 if (!isset($_SP_CONF['allow_php'])) {
diff -r 7af95656ab91 -r e0c7423ea657 plugins/staticpages/services.inc.php
--- a/plugins/staticpages/services.inc.php	Sat Mar 28 16:02:55 2009 +0100
+++ b/plugins/staticpages/services.inc.php	Sat Mar 28 17:00:42 2009 +0100
@@ -43,7 +43,10 @@
     die('This file can not be used on its own.');
 }
 
-// this must be kept in sync with the actual size of 'sp_id' in the db ...
+/**
+* Max. length of the ID for a static page.
+* This must be kept in sync with the actual size of 'sp_id' in the db.
+*/
 define('STATICPAGE_MAX_ID_LENGTH', 40);
 
 /**
diff -r 7af95656ab91 -r e0c7423ea657 public_html/lib-common.php
--- a/public_html/lib-common.php	Sat Mar 28 16:02:55 2009 +0100
+++ b/public_html/lib-common.php	Sat Mar 28 17:00:42 2009 +0100
@@ -80,11 +80,14 @@
     }
 }
 
-/*
+/**
 * Configuration Include:
 * You do NOT need to modify anything here any more!
 */
 require_once 'siteconfig.php' ;
+/**
+* Configuration class
+*/
 require_once $_CONF['path_system'] . 'classes/config.class.php';
 
 $config =& config::get_instance();
@@ -172,7 +175,7 @@
 
 /**
 * This is our HTML template class.  It is the same one found in PHPLib and is
-* licensed under the LGPL.  See that file for details
+* licensed under the LGPL.  See that file for details.
 *
 */
 
@@ -214,8 +217,9 @@
 * This is the custom library.
 *
 * It is the sandbox for every Geeklog Admin to play in.
-* We will never modify this file.  This should hold all custom
-* hacks to make upgrading easier.
+* The lib-custom.php as shipped will never contain required code,
+* so it's safe to always use your own copy.
+* This should hold all custom hacks to make upgrading easier.
 *
 */
 
@@ -299,8 +303,9 @@
     require_once $_CONF['path_layout'] . 'functions.php';
 }
 
-// ensure XHTML constant is defined to avoid problems elsewhere
-
+/**
+* ensure XHTML constant is defined to avoid problems elsewhere
+*/
 if (!defined('XHTML')) {
     switch ($_CONF['doctype']) {
     case 'xhtml10transitional':
@@ -6816,7 +6821,9 @@
     }
 }
 
-// Now include all plugin functions
+/**
+* Now include all plugin functions
+*/
 foreach ($_PLUGINS as $pi_name) {
     require_once $_CONF['path'] . 'plugins/' . $pi_name . '/functions.inc';
 }
diff -r 7af95656ab91 -r e0c7423ea657 public_html/polls/index.php
--- a/public_html/polls/index.php	Sat Mar 28 16:02:55 2009 +0100
+++ b/public_html/polls/index.php	Sat Mar 28 17:00:42 2009 +0100
@@ -39,6 +39,9 @@
 * @subpackage public_html
 */
 
+/**
+* Geeklog common function library
+*/
 require_once '../lib-common.php';
 
 if (!in_array('polls', $_PLUGINS)) {
diff -r 7af95656ab91 -r e0c7423ea657 public_html/staticpages/index.php
--- a/public_html/staticpages/index.php	Sat Mar 28 16:02:55 2009 +0100
+++ b/public_html/staticpages/index.php	Sat Mar 28 17:00:42 2009 +0100
@@ -38,6 +38,9 @@
 * @subpackage public_html
 */
 
+/**
+* Geeklog common function library
+*/
 require_once '../lib-common.php';
 
 if (!in_array('staticpages', $_PLUGINS)) {