doc comments on User::allowed_nickname

diff --git a/classes/User.php b/classes/User.php
index 964bc3e7f3b4f0ea48764f09a499ad69d3b4c037..92180a9fbc4d747b8809588cfdcd4040d4172d97 100644 (file)
--- a/classes/User.php
+++ b/classes/User.php
@@ -116,6 +116,16 @@ class User extends Memcached_DataObject
         return $result;
     }
 
+    /**
+     * Check whether the given nickname is potentially usable, or if it's
+     * excluded by any blacklists on this system.
+     *
+     * WARNING: INPUT IS NOT VALIDATED OR NORMALIZED. NON-NORMALIZED INPUT
+     * OR INVALID INPUT MAY LEAD TO FALSE RESULTS.
+     *
+     * @param string $nickname
+     * @return boolean true if clear, false if blacklisted
+     */
     static function allowed_nickname($nickname)
     {
         // XXX: should already be validated for size, content, etc.