class description fixes

Clansuite · Sep 29, 2012 · 3f30f53 · 3f30f53
1 parent efaae24
commit 3f30f53
Show file tree

Hide file tree

Showing 56 changed files with 65 additions and 54 deletions.
diff --git a/framework/Koch/Autoload/Loader.php b/framework/Koch/Autoload/Loader.php
@@ -26,7 +26,7 @@
 namespace Koch\Autoload;
 
 /**
- * Koch Loader
+ * Koch Framework - Class for Autoloading of Files by Classname.
  *
  * This Loader overwrites the Zend Engines _autoload() with our own user defined loading functions.
  * The main function of this class is autoload().

diff --git a/framework/Koch/Autoload/MapBuilder.php b/framework/Koch/Autoload/MapBuilder.php
@@ -26,12 +26,11 @@
 namespace Koch\Autoload;
 
 /**
- * MapBuilder builds a class map for usage with the autoloader.
+ * Koch Framework - Class for building class maps for the autoloader.
  *
  * A class map is a relationship of classname to filename.
  * The class map is used by the autoloader as a lookup table
  * to determine the file to load.
- *
  */
 class MapBuilder
 {

diff --git a/framework/Koch/Code/Reflection.php b/framework/Koch/Code/Reflection.php
@@ -26,7 +26,7 @@
 namespace Koch\Code;
 
 /**
- * Reflection
+ * Koch Framework - Class for Reflection and Introspection of Classes.
  *
  * Purpose of this class is to reverse-engineer classes,
  * interfaces, functions, methods and extensions.

diff --git a/framework/Koch/Config/AbstractConfig.php b/framework/Koch/Config/AbstractConfig.php
@@ -26,7 +26,7 @@
 namespace Koch\Config;
 
 /**
- * Koch Framework - Abstract Base Class for Config
+ * Koch Framework - Abstract Base Class for Config.
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Config/Adapter/CSV.php b/framework/Koch/Config/Adapter/CSV.php
@@ -26,7 +26,7 @@
 namespace Koch\Config\Adapter;
 
 /**
- * Koch Framework - Config Handler for CSV Format
+ * Koch Framework - Config Handler for CSV Format.
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Config/Adapter/INI.php b/framework/Koch/Config/Adapter/INI.php
@@ -26,7 +26,7 @@
 namespace Koch\Config\Adapter;
 
 /**
- * Koch Framework - Config Handler for INI Format
+ * Koch Framework - Config Handler for INI Format.
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Config/Adapter/JSON.php b/framework/Koch/Config/Adapter/JSON.php
@@ -26,7 +26,7 @@
 namespace Koch\Config\Adapter;
 
 /**
- * Koch Framework - Config Handler for Json Format
+ * Koch Framework - Config Handler for Json Format.
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Config/Adapter/Native.php b/framework/Koch/Config/Adapter/Native.php
@@ -26,7 +26,7 @@
 namespace Koch\Config\Adapter;
 
 /**
- * Koch Framework - Config Handler for PHP Format
+ * Koch Framework - Config Handler for PHP Format.
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Config/Adapter/XML.php b/framework/Koch/Config/Adapter/XML.php
@@ -26,7 +26,7 @@
 namespace Koch\Config\Adapter;
 
 /**
- * Koch Framework - Config Handler for XML Format (via SimpleXML)
+ * Koch Framework - Config Handler for XML Format (via SimpleXML).
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Config/Adapter/YAML.php b/framework/Koch/Config/Adapter/YAML.php
@@ -26,7 +26,7 @@
 namespace Koch\Config\Adapter;
 
 /**
- * Koch Framework - Config Handler for YAML Format
+ * Koch Framework - Config Handler for YAML Format.
  *
  * Purpose: This Confighandler supports the YAML-Fileformat.
  *

diff --git a/framework/Koch/Config/Config.php b/framework/Koch/Config/Config.php
@@ -26,7 +26,7 @@
 namespace Koch\Config;
 
 /**
- * Koch\Config
+ * Koch Framework - Provides a configuration container.
  *
  * This is a configuration container class.
  * It's build around the $config array, which is the storage container for settings.

diff --git a/framework/Koch/Config/Factory.php b/framework/Koch/Config/Factory.php
@@ -26,7 +26,7 @@
 namespace Koch\Config;
 
 /**
- * Configuration Factory
+ * Koch Framework - A Factory for Configuration Adapters.
  *
  * The static method getConfiguration() includes and instantiates
  * a Configuration Engine Object and injects the configfile.

diff --git a/framework/Koch/Config/Staging.php b/framework/Koch/Config/Staging.php
@@ -26,7 +26,7 @@
 namespace Koch\Config;
 
 /**
- * Staging
+ * Koch Framework - Class for Staging (Config overloading based on ServerName).
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/DI/DependencyInjector.php b/framework/Koch/DI/DependencyInjector.php
@@ -31,7 +31,7 @@
 use Koch\DI\Exception\MissingDependency;
 
 /**
- * Phemto - A Dependency Injector by Markus Baker.
+ * Koch Framework - Dependency Injector (Phemto by Markus Baker).
  *
  * Version: 0.1_alpha10 - SVN-Revision: 90
  *

diff --git a/framework/Koch/Doctrine/Doctrine.php b/framework/Koch/Doctrine/Doctrine.php
@@ -26,7 +26,7 @@
 namespace Koch\Doctrine;
 
 /**
- * Koch Framework - Class for the Initialization of Doctrine 2
+ * Koch Framework - Class for the Initialization of Doctrine 2.
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Event/Dispatcher.php b/framework/Koch/Event/Dispatcher.php
@@ -26,7 +26,7 @@
 namespace Koch\Event;
 
 /**
- * Eventdispatcher
+ * Koch Framework - Class for registering and triggering eventhandlers.
  *
  * Eventdispatcher is a container class for all the EventHandlers.
  * This class is a helper for event-driven development.

diff --git a/framework/Koch/Event/Event.php b/framework/Koch/Event/Event.php
@@ -26,7 +26,7 @@
 namespace Koch\Event;
 
 /**
- * Represents an Event
+ * Koch Framework - Class represents an Event.
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Event/EventInterface.php b/framework/Koch/Event/EventInterface.php
@@ -26,7 +26,7 @@
 namespace Koch\Event;
 
 /**
- * Interface for Event
+ * Koch Framework - Interface for all Events.
  *
  * Events have to implement at least a execute() method
  *

diff --git a/framework/Koch/Event/Loader.php b/framework/Koch/Event/Loader.php
@@ -26,7 +26,7 @@
 namespace Koch\Event;
 
 /**
- * Eventloader
+ * Koch Framework - Class for loading of Events from Config files.
  *
  * Purpose:
  * Eventloader handles the loading and registering of events by using event configuration files.

diff --git a/framework/Koch/Form/Form.php b/framework/Koch/Form/Form.php
@@ -26,7 +26,7 @@
 namespace Koch\Form;
 
 /**
- * Koch Framework - Class for Formular Handling
+ * Koch Framework - Class for creation and handling of HTML Forms.
  *
  * The Formular Object provides methods to deal with the following problem:
  *

diff --git a/framework/Koch/Form/FormDecorator.php b/framework/Koch/Form/FormDecorator.php
@@ -28,7 +28,7 @@
 use Koch\Form\DecoratorInterface;
 
 /**
- * Form_Decorator
+ * Koch Framework - Class for Decorating Forms.
  *
  * The base class for all decorators. It has the same type as Koch_Form itself.
  * The decorator pattern suggests that the decorator implements all public methods of the component which it decorates.

diff --git a/framework/Koch/Form/FormElement.php b/framework/Koch/Form/FormElement.php
@@ -26,7 +26,7 @@
 namespace Koch\Form;
 
 /**
- * FormElement
+ * Koch Framework - Class for a FormElement.
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Form/FormElementDecorator.php b/framework/Koch/Form/FormElementDecorator.php
@@ -26,7 +26,7 @@
 namespace Koch\Form;
 
 /**
- * Formelement_Decorator
+ * Koch Framework - Class for decorating a Formelement.
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Form/FormElementInterface.php b/framework/Koch/Form/FormElementInterface.php
@@ -25,8 +25,8 @@
 
 namespace Koch\Form;
 
- /**
- * Interface for a single Koch Framework Formelement
+/**
+ * Koch Framework - Interface for Formelements.
  */
 interface FormElementInterface
 {

diff --git a/framework/Koch/Form/FormGeneratorInterface.php b/framework/Koch/Form/FormGeneratorInterface.php
@@ -25,6 +25,9 @@
 
 namespace Koch\Form;
 
+/**
+ * Koch Framework - Interface for FormGenerators.
+ */
 interface FormGeneratorInterface
 {
     public function generate($array);

diff --git a/framework/Koch/Form/FormInterface.php b/framework/Koch/Form/FormInterface.php
@@ -26,7 +26,7 @@
 namespace Koch\Form;
 
 /**
- * Koch Framework - Interface for Form
+ * Koch Framework - Interface for the Form handling class.
  */
 interface FormInterface
 {

diff --git a/framework/Koch/Form/Validator.php b/framework/Koch/Form/Validator.php
@@ -25,6 +25,9 @@
 
 namespace Koch\Form;
 
+/**
+ * Koch Framework - Class for Validation of Forms. 
+ */
 abstract class Validator
 {
     /**

diff --git a/framework/Koch/Functions/Functions.php b/framework/Koch/Functions/Functions.php
@@ -26,7 +26,7 @@
 namespace Koch\Functions;
 
 /**
- * Koch FrameworkFunctions
+ * Koch Framework - Class Library for various static helper Functions.
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Http/HttpRequestInterface.php b/framework/Koch/Http/HttpRequestInterface.php
@@ -26,7 +26,7 @@
 namespace Koch\Http;
 
 /**
- * Interface for the Request Object
+ * Koch Framework - Interface for the Request Object.
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Http/HttpResponse.php b/framework/Koch/Http/HttpResponse.php
@@ -26,7 +26,7 @@
 namespace Koch\Http;
 
 /**
- * Koch Framework - Class for Response Handling
+ * Koch Framework - Class for Response Handling.
  *
  * This class represents the web response object on a request processed by Koch Framework.
  *

diff --git a/framework/Koch/Http/HttpResponseInterface.php b/framework/Koch/Http/HttpResponseInterface.php
@@ -26,7 +26,7 @@
 namespace Koch\Http;
 
 /**
- * Interface for the Response Object
+ * Koch Framework - Interface for the Response Object.
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Http/UserAgent.php b/framework/Koch/Http/UserAgent.php
@@ -26,7 +26,7 @@
 namespace Koch\Http;
 
 /**
- * Koch Framework - Class for Browser information
+ * Koch Framework - Class for acquiring Browser information.
  *
  * @category    Koch
  * @package     Tools

diff --git a/framework/Koch/Image/Crop.php b/framework/Koch/Image/Crop.php
@@ -26,7 +26,7 @@
 namespace Koch\Image;
 
 /**
- * Koch Framework - Class for Image Cropping
+ * Koch Framework - Class for Image Cropping.
  *
  * @package     Koch
  * @subpackage  Core

diff --git a/framework/Koch/Image/Image.php b/framework/Koch/Image/Image.php
@@ -26,7 +26,7 @@
 namespace Koch\Image;
 
 /**
- * Koch Framework - Class for Image Handling
+ * Koch Framework - Class for Image Handling.
  *
  * @package     Koch
  * @subpackage  Core

diff --git a/framework/Koch/Image/Thumbnail.php b/framework/Koch/Image/Thumbnail.php
@@ -26,7 +26,7 @@
 namespace Koch\Image;
 
 /**
- * Koch Framework - Class for Image Thumbnailing
+ * Koch Framework - Class for Image Thumbnailing.
  *
  * @package     Koch
  * @subpackage  Core

diff --git a/framework/Koch/Image/Watermark.php b/framework/Koch/Image/Watermark.php
@@ -26,7 +26,7 @@
 namespace Koch\Image;
 
 /**
- * Koch Framework - Class for Image Watermarking
+ * Koch Framework - Class for Image Watermarking.
  *
  * @package     Koch
  * @subpackage  Core

diff --git a/framework/Koch/Localization/Gettext.php b/framework/Koch/Localization/Gettext.php
@@ -26,7 +26,7 @@
 namespace Koch\Localization;
 
 /**
- * Gettext
+ * Koch Framework - Class for handling Gettext Extraction.
  *
  * 1. Gettext extraction is normally performed by the "xgettext" tool.
  *    http://www.gnu.org/software/hello/manual/gettext/xgettext-Invocation.html

diff --git a/framework/Koch/Localization/Localization.php b/framework/Koch/Localization/Localization.php
@@ -28,7 +28,7 @@
 use Koch\Config\Config;
 
 /**
- * Koch Framework - Class for Localization (l10n) & Internationalization (i18n) Handling
+ * Koch Framework - Class for Localization (l10n) & Internationalization (i18n) Handling.
  *
  * @category    Koch
  * @package     Core

diff --git a/framework/Koch/Localization/MbstringWrapper.php b/framework/Koch/Localization/MbstringWrapper.php
@@ -24,7 +24,7 @@
  */
 
 /**
- * Koch FrameworkMB_STRING Wrapper Methods
+ * Koch Framework - Class provides MB_STRING Wrapper Methods.
  *
  * Koch Frameworkrelies on mb_string functions.
  * If the mbstring extension is not loaded, the mb_string functions are not available.

diff --git a/framework/Koch/Localization/Utf8.php b/framework/Koch/Localization/Utf8.php
@@ -26,7 +26,7 @@
 namespace Koch\Localization;
 
 /**
- * Koch Framework - UTF8
+ * Koch Framework - Class for Initalizing UTF8 (fallbacks).
  *
  * Koch Framework relies on mbstring.
  * This class allows running the application without the mbstring extension.

diff --git a/framework/Koch/Logger/Adapter/Email.php b/framework/Koch/Logger/Adapter/Email.php
@@ -28,7 +28,7 @@
 use Koch\Logger\LoggerInterface;
 
 /**
- * Koch Framework - Log to email.
+ * Koch Framework - Log to EMail.
  *
  * This class is a service wrapper for sending logging messages via email.
  * The email is send using the Koch_Mailer, which is a wrapper for SwiftMailer.

diff --git a/framework/Koch/Logger/Adapter/File.php b/framework/Koch/Logger/Adapter/File.php
@@ -28,7 +28,7 @@
 use Koch\Logger\LoggerInterface;
 
 /**
- * Koch Framework - Log to file.
+ * Koch Framework - Log to File.
  *
  * This class is a service wrapper for logging messages to a logfile.
  *

diff --git a/framework/Koch/Logger/Compositum.php b/framework/Koch/Logger/Compositum.php
@@ -26,7 +26,7 @@
 namespace Koch\Logger;
 
 /**
- * Logger
+ * Koch Framework - Class provides a compositum for loggers.
  *
  * This class represents a compositum for all registered loggers.
  * Another name for this class would be MultiLog.