diff --git a/lib/Cake/Cache/Engine/FileEngine.php b/lib/Cake/Cache/Engine/FileEngine.php index 5357324b5..b18766013 100644 --- a/lib/Cake/Cache/Engine/FileEngine.php +++ b/lib/Cake/Cache/Engine/FileEngine.php @@ -21,7 +21,11 @@ */ /** - * File Storage engine for cache + * File Storage engine for cache. Filestorage is the slowest cache storage + * to read and write. However, it is good for servers that don't have other storage + * engine available, or have content which is not performance sensitive. + * + * You can configure a FileEngine cache, using Cache::config() * * @package Cake.Cache.Engine */ diff --git a/lib/Cake/Console/Command/ApiShell.php b/lib/Cake/Console/Command/ApiShell.php index 653189029..7018c03bc 100644 --- a/lib/Cake/Console/Command/ApiShell.php +++ b/lib/Cake/Console/Command/ApiShell.php @@ -24,6 +24,8 @@ App::uses('File', 'Utility'); /** * API shell to show method signatures of CakePHP core classes. * + * Implementation of a Cake Shell to show CakePHP core method signatures. + * * @package Cake.Console.Command */ class ApiShell extends AppShell { diff --git a/lib/Cake/Console/Command/BakeShell.php b/lib/Cake/Console/Command/BakeShell.php index 05e678e92..77d4fe610 100644 --- a/lib/Cake/Console/Command/BakeShell.php +++ b/lib/Cake/Console/Command/BakeShell.php @@ -24,7 +24,11 @@ App::uses('AppShell', 'Console/Command'); App::uses('Model', 'Model'); /** - * Bake is a command-line code generation utility for automating programmer chores. + * Command-line code generation utility to automate programmer chores. + * + * Bake is CakePHP's code generation script, which can help you kickstart + * application development by writing fully functional skeleton controllers, + * models, and views. Going further, Bake can also write Unit Tests for you. * * @package Cake.Console.Command * @link http://book.cakephp.org/2.0/en/console-and-shells/code-generation-with-bake.html diff --git a/lib/Cake/Console/Command/SchemaShell.php b/lib/Cake/Console/Command/SchemaShell.php index c65429cc3..06c2da394 100644 --- a/lib/Cake/Console/Command/SchemaShell.php +++ b/lib/Cake/Console/Command/SchemaShell.php @@ -27,6 +27,9 @@ App::uses('CakeSchema', 'Model'); /** * Schema is a command-line database management utility for automating programmer chores. * + * Schema is CakePHP's database management utility. This helps you maintain versions of + * of your database. + * * @package Cake.Console.Command * @link http://book.cakephp.org/2.0/en/console-and-shells/schema-management-and-migrations.html */ diff --git a/lib/Cake/Console/Command/Task/PluginTask.php b/lib/Cake/Console/Command/Task/PluginTask.php index 36af64a9b..056780dd1 100644 --- a/lib/Cake/Console/Command/Task/PluginTask.php +++ b/lib/Cake/Console/Command/Task/PluginTask.php @@ -21,7 +21,7 @@ App::uses('File', 'Utility'); App::uses('Folder', 'Utility'); /** - * Task class for creating a plugin + * The Plugin Task handles creating an empty plugin, ready to be used * * @package Cake.Console.Command.Task */ diff --git a/lib/Cake/Controller/CakeErrorController.php b/lib/Cake/Controller/CakeErrorController.php index 51934c34e..232286d46 100644 --- a/lib/Cake/Controller/CakeErrorController.php +++ b/lib/Cake/Controller/CakeErrorController.php @@ -18,6 +18,14 @@ * @since CakePHP(tm) v 2.0 * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ + +/** + * Error Handling Controller + * + * Controller used by ErrorHandler to render error views. + * + * @package Cake.Controller + */ class CakeErrorController extends AppController { /** diff --git a/lib/Cake/Controller/Component/RequestHandlerComponent.php b/lib/Cake/Controller/Component/RequestHandlerComponent.php index ca7372261..2279653b8 100644 --- a/lib/Cake/Controller/Component/RequestHandlerComponent.php +++ b/lib/Cake/Controller/Component/RequestHandlerComponent.php @@ -22,7 +22,11 @@ App::uses('Xml', 'Utility'); /** - * Request object for handling HTTP requests + * Request object for handling alternative HTTP requests + * + * Alternative HTTP requests can come from wireless units like mobile phones, palmtop computers, + * and the like. These units have no use for Ajax requests, and this Component can tell how Cake + * should respond to the different needs of a handheld computer and a desktop machine. * * @package Cake.Controller.Component * @link http://book.cakephp.org/2.0/en/core-libraries/components/request-handling.html diff --git a/lib/Cake/Controller/Component/SecurityComponent.php b/lib/Cake/Controller/Component/SecurityComponent.php index 204209db0..d9f32c1fd 100644 --- a/lib/Cake/Controller/Component/SecurityComponent.php +++ b/lib/Cake/Controller/Component/SecurityComponent.php @@ -22,7 +22,14 @@ App::uses('String', 'Utility'); App::uses('Security', 'Utility'); /** - * SecurityComponent + * The Security Component creates an easy way to integrate tighter security in + * your application. It provides methods for various tasks like: + * + * - Restricting which HTTP methods your application accepts. + * - CSRF protection. + * - Form tampering protection + * - Requiring that SSL be used. + * - Limiting cross controller communication. * * @package Cake.Controller.Component * @link http://book.cakephp.org/2.0/en/core-libraries/components/security-component.html diff --git a/lib/Cake/Controller/Component/SessionComponent.php b/lib/Cake/Controller/Component/SessionComponent.php index b52a3013a..52b0a1c28 100644 --- a/lib/Cake/Controller/Component/SessionComponent.php +++ b/lib/Cake/Controller/Component/SessionComponent.php @@ -1,6 +1,6 @@ * Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org) * @@ -16,10 +12,12 @@ * @since CakePHP(tm) v 1.2.0.4667 * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ + App::uses('CakeSchema', 'Model'); /** - * Short description for class. + * CakeTestFixture is responsible for building and destroying tables to be used + * during testing. * * @package Cake.TestSuite.Fixture */ diff --git a/lib/Cake/TestSuite/Fixture/CakeTestModel.php b/lib/Cake/TestSuite/Fixture/CakeTestModel.php index c9ad1ac6f..bed356253 100644 --- a/lib/Cake/TestSuite/Fixture/CakeTestModel.php +++ b/lib/Cake/TestSuite/Fixture/CakeTestModel.php @@ -1,9 +1,5 @@ * Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org) * @@ -20,7 +16,7 @@ App::uses('Model', 'Model'); /** - * Short description for class. + * A model to extend from to help you during testing. * * @package Cake.TestSuite.Fixture */ diff --git a/lib/Cake/Utility/Debugger.php b/lib/Cake/Utility/Debugger.php index 5c83fd122..c6b2a0ffb 100644 --- a/lib/Cake/Utility/Debugger.php +++ b/lib/Cake/Utility/Debugger.php @@ -19,10 +19,6 @@ * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ -/** - * Included libraries. - * - */ App::uses('CakeLog', 'Log'); App::uses('String', 'Utility'); diff --git a/lib/Cake/Utility/File.php b/lib/Cake/Utility/File.php index 3e0cb9f55..46b9225a0 100644 --- a/lib/Cake/Utility/File.php +++ b/lib/Cake/Utility/File.php @@ -17,10 +17,6 @@ * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ -/** - * Included libraries. - * - */ App::uses('Folder', 'Utility'); /** diff --git a/lib/Cake/Utility/ObjectCollection.php b/lib/Cake/Utility/ObjectCollection.php index c3fdeed6b..79e1712d1 100644 --- a/lib/Cake/Utility/ObjectCollection.php +++ b/lib/Cake/Utility/ObjectCollection.php @@ -10,6 +10,7 @@ * @link http://cakephp.org CakePHP(tm) Project * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ + /** * Deals with Collections of objects. Keeping registries of those objects, * loading and constructing new objects and triggering callbacks. Each subclass needs diff --git a/lib/Cake/Utility/Sanitize.php b/lib/Cake/Utility/Sanitize.php index 3fff82d8e..77774a4f5 100644 --- a/lib/Cake/Utility/Sanitize.php +++ b/lib/Cake/Utility/Sanitize.php @@ -18,6 +18,7 @@ * @since CakePHP(tm) v 0.10.0.1076 * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ + App::import('Model', 'ConnectionManager'); /** diff --git a/lib/Cake/Utility/Xml.php b/lib/Cake/Utility/Xml.php index ee9bfe90b..093be4f44 100644 --- a/lib/Cake/Utility/Xml.php +++ b/lib/Cake/Utility/Xml.php @@ -19,6 +19,13 @@ * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ +/** + * XML handling for Cake. + * + * The methods in these classes enable the datasources that use XML to work. + * + * @package Cake.Utility + */ class Xml { /** diff --git a/lib/Cake/View/Helper/AppHelper.php b/lib/Cake/View/Helper/AppHelper.php index 97b169d12..73d2ef28e 100644 --- a/lib/Cake/View/Helper/AppHelper.php +++ b/lib/Cake/View/Helper/AppHelper.php @@ -19,6 +19,7 @@ * @since CakePHP(tm) v 0.2.9 * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ + App::uses('Helper', 'View'); /** diff --git a/lib/Cake/View/Helper/JqueryEngineHelper.php b/lib/Cake/View/Helper/JqueryEngineHelper.php index 90f9e4792..06db8adda 100644 --- a/lib/Cake/View/Helper/JqueryEngineHelper.php +++ b/lib/Cake/View/Helper/JqueryEngineHelper.php @@ -26,6 +26,17 @@ App::uses('AppHelper', 'View/Helper'); App::uses('JsBaseEngineHelper', 'View/Helper'); +/** + * jQuery Engine Helper for JsHelper + * + * Provides jQuery specific Javascript for JsHelper. + * + * Implements the JsHelper interface for jQuery. All $options arrays + * support all options found in the JsHelper, as well as those in the jQuery + * documentation. + * + * @package Cake.View.Helper + */ class JqueryEngineHelper extends JsBaseEngineHelper { /** * Option mappings for jQuery diff --git a/lib/Cake/View/Helper/MootoolsEngineHelper.php b/lib/Cake/View/Helper/MootoolsEngineHelper.php index 5b1ee301b..ea3ce8b3f 100644 --- a/lib/Cake/View/Helper/MootoolsEngineHelper.php +++ b/lib/Cake/View/Helper/MootoolsEngineHelper.php @@ -27,6 +27,19 @@ App::uses('JsBaseEngineHelper', 'View/Helper'); +/** + * MooTools Engine Helper for JsHelper + * + * Provides MooTools specific Javascript for JsHelper. + * Assumes that you have the following MooTools packages + * + * - Remote, Remote.HTML, Remote.JSON + * - Fx, Fx.Tween, Fx.Morph + * - Selectors, DomReady, + * - Drag, Drag.Move + * + * @package Cake.View.Helper + */ class MootoolsEngineHelper extends JsBaseEngineHelper { /** * Option mappings for MooTools diff --git a/lib/Cake/View/Helper/PrototypeEngineHelper.php b/lib/Cake/View/Helper/PrototypeEngineHelper.php index e8dc0e095..69f755699 100644 --- a/lib/Cake/View/Helper/PrototypeEngineHelper.php +++ b/lib/Cake/View/Helper/PrototypeEngineHelper.php @@ -22,6 +22,14 @@ App::uses('JsBaseEngineHelper', 'View/Helper'); +/** + * Prototype Engine Helper for JsHelper + * + * Provides Prototype specific Javascript for JsHelper. Requires at least + * Prototype 1.6 + * + * @package Cake.View.Helper + */ class PrototypeEngineHelper extends JsBaseEngineHelper { /** * Is the current selection a multiple selection? or is it just a single element. diff --git a/lib/Cake/View/Helper/TextHelper.php b/lib/Cake/View/Helper/TextHelper.php index 34465a2fe..ee35d594d 100644 --- a/lib/Cake/View/Helper/TextHelper.php +++ b/lib/Cake/View/Helper/TextHelper.php @@ -19,10 +19,6 @@ * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ -/** - * Included libraries. - * - */ App::uses('AppHelper', 'View/Helper'); App::uses('HtmlHelper', 'Helper'); App::uses('Multibyte', 'I18n'); diff --git a/lib/Cake/View/Helper/TimeHelper.php b/lib/Cake/View/Helper/TimeHelper.php index 31d5aad53..729f3436e 100644 --- a/lib/Cake/View/Helper/TimeHelper.php +++ b/lib/Cake/View/Helper/TimeHelper.php @@ -16,6 +16,7 @@ * @since CakePHP(tm) v 0.10.0.1076 * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ + App::uses('Multibyte', 'I18n'); App::uses('AppHelper', 'View/Helper'); diff --git a/lib/Cake/View/HelperCollection.php b/lib/Cake/View/HelperCollection.php index fb1b55260..4bc191400 100644 --- a/lib/Cake/View/HelperCollection.php +++ b/lib/Cake/View/HelperCollection.php @@ -18,6 +18,12 @@ App::uses('ObjectCollection', 'Utility'); +/** + * Helpers collection is used as a registry for loaded helpers and handles loading + * and constructing helper class objects. + * + * @package Cake.View + */ class HelperCollection extends ObjectCollection { /** diff --git a/lib/Cake/View/MediaView.php b/lib/Cake/View/MediaView.php index eeb789f1e..96fdf543b 100644 --- a/lib/Cake/View/MediaView.php +++ b/lib/Cake/View/MediaView.php @@ -16,6 +16,7 @@ * @since CakePHP(tm) v 1.2.0.5714 * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ + App::uses('View', 'View'); App::uses('CakeRequest', 'Network'); diff --git a/lib/Cake/View/ScaffoldView.php b/lib/Cake/View/ScaffoldView.php index 62c46f04f..f97ecc653 100644 --- a/lib/Cake/View/ScaffoldView.php +++ b/lib/Cake/View/ScaffoldView.php @@ -18,6 +18,7 @@ * @since Cake v 0.10.0.1076 * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ + App::uses('ThemeView', 'View'); /** diff --git a/lib/Cake/View/ThemeView.php b/lib/Cake/View/ThemeView.php index 2a499aee2..13cfcafb0 100644 --- a/lib/Cake/View/ThemeView.php +++ b/lib/Cake/View/ThemeView.php @@ -16,6 +16,7 @@ * @since CakePHP(tm) v 0.10.0.1076 * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ + App::uses('View', 'View'); /** diff --git a/lib/Cake/View/View.php b/lib/Cake/View/View.php index ac7ae45b4..badbf0780 100644 --- a/lib/Cake/View/View.php +++ b/lib/Cake/View/View.php @@ -17,9 +17,6 @@ * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ -/** - * Included libraries. - */ App::uses('HelperCollection', 'View'); App::uses('AppHelper', 'View/Helper'); App::uses('Router', 'Routing');