From: pdontthink <pdontthink@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Date: Tue, 26 Feb 2008 20:28:02 +0000 (+0000)
Subject: Add docs
X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=commitdiff_plain;h=8abb7e3a2052423e641a320be203a58a610cf0b1;hp=dd6f96279bebfdf151c1be4301fbac5696f89994

Add docs

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@12969 7612ce4b-ef26-0410-bec9-ea0150e637f0
---

diff --git a/src/options.php b/src/options.php
index c5957977..bfcbc358 100644
--- a/src/options.php
+++ b/src/options.php
@@ -43,6 +43,19 @@ define('SMOPT_PAGE_HIGHLIGHT', 'highlight');
 define('SMOPT_PAGE_FOLDER', 'folder');
 define('SMOPT_PAGE_ORDER', 'order');
 
+/**
+  * Save submitted options and calculate the most 
+  * we need to refresh the page
+  *
+  * @param string $optpage      The name of the page being submitted
+  * @param array  $optpage_data An array of all the submitted options
+  *
+  * @return int The highest level of screen refresh needed per
+  *             the options that were changed.  This value will
+  *             correspond to the SMOPT_REFRESH_* constants found
+  *             in functions/options.php.
+  *
+  */
 function process_optionmode_submit($optpage, $optpage_data) {
     /* Initialize the maximum option refresh level. */
     $max_refresh = SMOPT_REFRESH_NONE;