Version 3.3.4

upload/ips_kernel/classCaptchaPlugin/default.php

@@ -3,12 +3,12 @@
  * @file		default.php 	Plugin for the default CAPTCHA GD image
  *~TERABYTE_DOC_READY~
  * $Copyright: (c) 2001 - 2011 Invision Power Services, Inc.$
- * $License: This is NULLED!
+ * $License: http://www.invisionpower.com/company/standards.php#license$
  * $Author: bfarber $
  * @since		Friday 19th May 2006 17:33
- * $LastChangedDate: 2011-08-17 17:49:31 -0400 (Wed, 17 Aug 2011) $
- * @version		v3.2.3
- * $Revision: 9396 $
+ * $LastChangedDate: 2012-02-10 20:05:52 -0500 (Fri, 10 Feb 2012) $
+ * @version		v3.3.4
+ * $Revision: 10288 $
  */
 
 /**
@@ -20,37 +20,35 @@
  */
 class captchaPlugin
 {
-	/**
+	/**#@+
 	 * Registry Object Shortcuts
 	 *
-	 * @var		$registry
-	 * @var		$DB
-	 * @var		$settings
-	 * @var		$member
+	 * @var		object
 	 */
 	public $registry;
 	public $DB;
 	public $settings;
 	public $member;
+	/**#@-*/
 	
 	/**
 	 * String that stores the backgrounds path
 	 *
-	 * @var		$path_background
+	 * @var		string
 	 */
 	public $path_background		= '';
 	
 	/**
 	 * String that stores the fonts path
 	 *
-	 * @var		$path_fonts
+	 * @var		string
 	 */
 	public $path_fonts			= '';
 
 	/**
 	 * String that stores the captcha key
 	 *
-	 * @var		$captchaKey
+	 * @var		string
 	 */
 	public $captchaKey 			= '';
 	
@@ -75,7 +73,7 @@ class captchaPlugin
 	/**
 	 * Returns the captcha template
 	 *
-	 * @return	@e string HTML template for captcha GD form
+	 * @return	@e string
 	 *
 	 * <b>Example Usage:</b>
 	 * @code
@@ -135,9 +133,9 @@ class captchaPlugin
 	}
 	
 	/**
-	 * Validates the entered captcha code
+	 * Validates the entered captcha code, returning true on success and false on failure
 	 *
-	 * @return	@e boolean TRUE if the code is valid otherwise FALSE
+	 * @return	@e boolean
 	 *
 	 * <b>Example Usage:</b>
 	 * @code
@@ -171,10 +169,10 @@ class captchaPlugin
 	}
 	
 	/**
-	 * Generates the captcha image
+	 * Generates the captcha image.  Returns false on failure.
 	 *
 	 * @param	array		$captcha_unique_id		Key 0 of the array contains the Unique ID
-	 * @return	@e mixed Prints image data and headers on success otherwise FALSE on failure
+	 * @return	@e mixed
 	 *
 	 * <b>Example Usage:</b>
 	 * @code
@@ -210,7 +208,7 @@ class captchaPlugin
 	 * Prints captcha image and headers
 	 *
 	 * @param	string		$content		Key to show in the GD image
-	 * @return	@e void Prints image data and headers
+	 * @return	@e void
 	 *
 	 * <b>Example Usage:</b>
 	 * @code
@@ -618,7 +616,7 @@ class captchaPlugin
 	 *
 	 * @param	resources		$im		Image resource
 	 * @param	integer			$wave	Wave factor
-	 * @return	@e resource Returned image resource
+	 * @return	@e resource
 	 *
 	 * <b>Example Usage:</b>
 	 * @code
@@ -686,7 +684,7 @@ class captchaPlugin
 	/**
 	 * Retrieves the list of backgrounds from the specified path
 	 *
-	 * @return	@e array List of backgrouns found
+	 * @return	@e array
 	 *
 	 * <b>Example Usage:</b>
 	 * @code
@@ -717,7 +715,7 @@ class captchaPlugin
 	/**
 	 * Retrieves the list of fonts from the specified path
 	 *
-	 * @return	@e array List of fonts found
+	 * @return	@e array
 	 *
 	 * <b>Example Usage:</b>
 	 * @code