Fix wrong doc

[squirrelmail.git] / functions / strings.php

diff --git a/functions/strings.php b/functions/strings.php
index f2d882af3c11e9106f05dddc0b3c7bcfd2173a45..b67eed3d6685072585cd77e908919b1994ce18b7 100644 (file)
--- a/functions/strings.php
+++ b/functions/strings.php
@@ -6,7 +6,7 @@
  * This code provides various string manipulation functions that are
  * used by the rest of the SquirrelMail code.
  *
- * @copyright © 1999-2009 The SquirrelMail Project Team
+ * @copyright 1999-2009 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
@@ -1305,11 +1305,12 @@ function sm_get_user_security_tokens($purge_old=TRUE)
   *
   * WARNING: If the administrator has turned the token system
   *          off by setting $disable_security_tokens to TRUE in
-  *          config/config_local.php, this function will not
-  *          store tokens in the user preferences (but it will
-  *          still generate and return a random string).
+  *          config/config.php or the configuration tool, this
+  *          function will not store tokens in the user
+  *          preferences (but it will still generate and return
+  *          a random string).
   *
-  * @return void
+  * @return string A security token
   *
   * @since 1.4.19 and 1.5.2
   *
@@ -1357,8 +1358,8 @@ function sm_generate_security_token()
   *
   * WARNING: If the administrator has turned the token system
   *          off by setting $disable_security_tokens to TRUE in
-  *          config/config_local.php, this function will always
-  *          return TRUE.
+  *          config/config.php or the configuration tool, this
+  *          function will always return TRUE.
   *
   * @param string  $token           The token to validate
   * @param int     $validity_period The number of seconds tokens are valid