[geeklog-cvs] geeklog: Some more phpDocumentor tags for the Links plugin

[geeklog-cvs at lists.geeklog.net]

details:   http://project.geeklog.net/cgi-bin/hgweb.cgi/rev/2fe75e6e9505
changeset: 6835:2fe75e6e9505
user:      Dirk Haun <dirk at haun-online.de>
date:      Sun Mar 15 16:50:01 2009 +0100
description:
Some more phpDocumentor tags for the Links plugin

diffstat:

3 files changed, 36 insertions(+), 4 deletions(-)
plugins/links/autoinstall.php      |   26 ++++++++++++++++++++++++++
plugins/links/functions.inc        |    4 ++++
plugins/links/install_defaults.php |   10 ++++++----

diffs (98 lines):

diff -r 4304c303cc45 -r 2fe75e6e9505 plugins/links/autoinstall.php
--- a/plugins/links/autoinstall.php	Sun Mar 15 16:31:07 2009 +0100
+++ b/plugins/links/autoinstall.php	Sun Mar 15 16:50:01 2009 +0100
@@ -29,6 +29,17 @@
 // |                                                                           |
 // +---------------------------------------------------------------------------+
 
+/**
+* @package Links
+*/
+
+/**
+* Plugin autoinstall function
+*
+* @param    string  $pi_name    Plugin name
+* @return   array               Plugin information
+*
+*/
 function plugin_autoinstall_links($pi_name)
 {
     $pi_name         = 'links';
@@ -76,6 +87,14 @@
     return $inst_parms;
 }
 
+/**
+* Load plugin configuration from database
+*
+* @param    string  $pi_name    Plugin name
+* @return   boolean             true on success, otherwise false
+* @see      plugin_initconfig_links
+*
+*/
 function plugin_load_configuration_links($pi_name)
 {
     global $_CONF;
@@ -133,6 +152,13 @@
     return true;
 }
 
+/**
+* Check if the plugin is compatible with this Geeklog version
+*
+* @param    string  $pi_name    Plugin name
+* @return   boolean             true: plugin compatible; false: not compatible
+*
+*/
 function plugin_compatible_with_this_version_links($pi_name)
 {
     if (!function_exists('COM_truncate') || !function_exists('MBYTE_strpos')) {
diff -r 4304c303cc45 -r 2fe75e6e9505 plugins/links/functions.inc
--- a/plugins/links/functions.inc	Sun Mar 15 16:31:07 2009 +0100
+++ b/plugins/links/functions.inc	Sun Mar 15 16:50:01 2009 +0100
@@ -35,6 +35,10 @@
 // | Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.           |
 // |                                                                           |
 // +---------------------------------------------------------------------------+
+
+/**
+* @package Links
+*/
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'functions.inc') !== false) {
     die('This file can not be used on its own.');
diff -r 4304c303cc45 -r 2fe75e6e9505 plugins/links/install_defaults.php
--- a/plugins/links/install_defaults.php	Sun Mar 15 16:31:07 2009 +0100
+++ b/plugins/links/install_defaults.php	Sun Mar 15 16:50:01 2009 +0100
@@ -2,7 +2,7 @@
 
 // Reminder: always indent with 4 spaces (no tabs).
 // +---------------------------------------------------------------------------+
-// | Links Plugin 2.0                                                          |
+// | Links Plugin 2.1                                                          |
 // +---------------------------------------------------------------------------+
 // | install_defaults.php                                                      |
 // |                                                                           |
@@ -10,7 +10,7 @@
 // | records. These settings are only used during the initial installation     |
 // | and not referenced any more once the plugin is installed.                 |
 // +---------------------------------------------------------------------------+
-// | Copyright (C) 2000-2008 by the following authors:                         |
+// | Copyright (C) 2000-2009 by the following authors:                         |
 // |                                                                           |
 // | Authors: Tony Bibbs         - tony AT tonybibbs DOT com                   |
 // |          Mark Limburg       - mlimburg AT users.sourceforge DOT net       |
@@ -35,8 +35,10 @@
 // | Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.           |
 // |                                                                           |
 // +---------------------------------------------------------------------------+
-//
-// $Id: install_defaults.php,v 1.8 2008/09/22 07:53:40 dhaun Exp $
+
+/**
+* @package Links
+*/
 
 if (strpos(strtolower($_SERVER['PHP_SELF']), 'install_defaults.php') !== false) {
     die('This file can not be used on its own!');