From 8885e6bcacdab7ec406501f2290a70ebb63e9b71 Mon Sep 17 00:00:00 2001 From: Jeremy Livingston Date: Mon, 3 Dec 2012 19:02:43 -0500 Subject: [PATCH] Add class documentation --- Generator/CaptchaGenerator.php | 5 ++++- Generator/ImageBuilder.php | 8 +++++++- Generator/ImageFileHandler.php | 3 +++ 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/Generator/CaptchaGenerator.php b/Generator/CaptchaGenerator.php index 7c2e099..6af0b91 100644 --- a/Generator/CaptchaGenerator.php +++ b/Generator/CaptchaGenerator.php @@ -7,7 +7,10 @@ use Symfony\Component\HttpFoundation\Session\SessionInterface; use Symfony\Component\Routing\RouterInterface; /** - * Generates a CAPTCHA image + * Uses configuration parameters to call the services that generate captcha images + * + * @author Gregwar + * @author Jeremy Livingston */ class CaptchaGenerator { diff --git a/Generator/ImageBuilder.php b/Generator/ImageBuilder.php index 9f1e68b..f94006d 100644 --- a/Generator/ImageBuilder.php +++ b/Generator/ImageBuilder.php @@ -4,7 +4,13 @@ namespace Gregwar\CaptchaBundle\Generator; use Symfony\Component\Finder\Finder; - +/** + * Builds a new captcha image + * Uses the fingerprint parameter, if one is passed, to generate the same image + * + * @author Gregwar + * @author Jeremy Livingston + */ class ImageBuilder { /** diff --git a/Generator/ImageFileHandler.php b/Generator/ImageFileHandler.php index 2611401..1a47420 100644 --- a/Generator/ImageFileHandler.php +++ b/Generator/ImageFileHandler.php @@ -5,6 +5,9 @@ namespace Gregwar\CaptchaBundle\Generator; use Symfony\Component\Finder\Finder; /** + * Handles actions related to captcha image files including saving and garbage collection + * + * @author Gregwar * @author Jeremy Livingston */ class ImageFileHandler