From 2a880038a34d04212ab2869a1a4f135e9c8338ab Mon Sep 17 00:00:00 2001 From: tokul Date: Mon, 12 Apr 2004 07:15:29 +0000 Subject: [PATCH 1/1] phpdoc blocks and one more string git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@7086 7612ce4b-ef26-0410-bec9-ea0150e637f0 --- plugins/bug_report/bug_report.php | 10 ++++++++-- plugins/bug_report/index.php | 2 +- plugins/bug_report/setup.php | 33 +++++++++++++++++++++---------- 3 files changed, 32 insertions(+), 13 deletions(-) diff --git a/plugins/bug_report/bug_report.php b/plugins/bug_report/bug_report.php index d7b9b24d..2069d2e5 100644 --- a/plugins/bug_report/bug_report.php +++ b/plugins/bug_report/bug_report.php @@ -13,7 +13,7 @@ * * This is a standard Squirrelmail-1.2 API for plugins. * - * $Id$ + * @version $Id$ * @package plugins * @subpackage bug_report */ @@ -30,7 +30,13 @@ require_once(SM_PATH . 'functions/forms.php'); displayPageHeader($color, 'None'); - +/** + * converts array to string + * + * @param array $array array that has to be displayed + * @return string + * @access private + */ function Show_Array($array) { $str = ''; foreach ($array as $key => $value) { diff --git a/plugins/bug_report/index.php b/plugins/bug_report/index.php index 2d2e576c..518cf662 100644 --- a/plugins/bug_report/index.php +++ b/plugins/bug_report/index.php @@ -8,7 +8,7 @@ ** ** Redirects to the login page. ** - ** $Id$ + * @version $Id$ * @package plugins * @subpackage bug_report **/ diff --git a/plugins/bug_report/setup.php b/plugins/bug_report/setup.php index b80a97bb..cba06385 100644 --- a/plugins/bug_report/setup.php +++ b/plugins/bug_report/setup.php @@ -8,7 +8,7 @@ * * This is a standard Squirrelmail-1.2 API for plugins. * - * $Id$ + * @version $Id$ * @package plugins * @subpackage bug_report */ @@ -20,6 +20,7 @@ /** * Initialize the bug report plugin * @return void + * @access private */ function squirrelmail_plugin_init_bug_report() { global $squirrelmail_plugin_hooks; @@ -31,7 +32,10 @@ function squirrelmail_plugin_init_bug_report() { } -/* Show the button in the main bar */ +/** + * Show the button in the main bar + * @access private + */ function bug_report_button() { global $color, $bug_report_visible; @@ -39,11 +43,14 @@ function bug_report_button() { return; } - displayInternalLink('plugins/bug_report/bug_report.php', 'Bug', ''); + displayInternalLink('plugins/bug_report/bug_report.php', _("Bug"), ''); echo "  \n"; } - +/** + * Saves bug report options + * @access private + */ function bug_report_save() { global $username,$data_dir; @@ -54,7 +61,10 @@ function bug_report_save() { } } - +/** + * Loads bug report options + * @access private + */ function bug_report_load() { global $username, $data_dir; global $bug_report_visible; @@ -62,16 +72,19 @@ function bug_report_load() { $bug_report_visible = getPref($data_dir, $username, 'bug_report_visible'); } - +/** + * Adds bug report options to display page + * @access private + */ function bug_report_options() { global $bug_report_visible; echo '' . html_tag('td',_("Bug Reports:"),'right','','nowrap') . "\n" . - ' ' . _("Show button in toolbar") . "\n"; + echo ' /> ' . _("Show button in toolbar") . "\n"; } -?> +?> \ No newline at end of file -- 2.25.1