From 8decc683ac46f5f00e026ef2cbeb4873330f3e2e Mon Sep 17 00:00:00 2001
From: predominant <graham@grahamweldon.com>
Date: Sun, 30 May 2010 01:20:28 +1000
Subject: [PATCH] Numerous 'shoer description' documentation entries updated to
 contain useful comments.

---
 cake/console/libs/console.php                            | 2 +-
 cake/console/libs/i18n.php                               | 2 +-
 cake/console/templates/skel/app_controller.php           | 4 ++--
 cake/console/templates/skel/app_helper.php               | 2 +-
 cake/console/templates/skel/config/acl.ini.php           | 2 +-
 cake/console/templates/skel/config/routes.php            | 2 +-
 cake/console/templates/skel/webroot/css.php              | 2 +-
 cake/libs/controller/app_controller.php                  | 2 +-
 cake/libs/controller/components/cookie.php               | 2 +-
 cake/libs/controller/components/email.php                | 2 +-
 cake/libs/controller/components/security.php             | 5 +++--
 cake/libs/i18n.php                                       | 2 +-
 cake/libs/l10n.php                                       | 4 ++--
 cake/libs/model/behaviors/acl.php                        | 2 +-
 cake/libs/model/behaviors/translate.php                  | 4 ++--
 cake/libs/model/datasources/dbo/dbo_mssql.php            | 2 +-
 cake/libs/model/datasources/dbo/dbo_oracle.php           | 2 +-
 cake/libs/model/datasources/dbo_source.php               | 2 +-
 cake/libs/model/db_acl.php                               | 2 +-
 cake/libs/security.php                                   | 2 +-
 cake/libs/view/helpers/app_helper.php                    | 2 +-
 cake/tests/cases/libs/controller/components/acl.test.php | 2 +-
 22 files changed, 27 insertions(+), 26 deletions(-)

diff --git a/cake/console/libs/console.php b/cake/console/libs/console.php
index 41e4d4634..ac7b595bb 100644
--- a/cake/console/libs/console.php
+++ b/cake/console/libs/console.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * CakePHP Console Shell
  *
  * PHP versions 4 and 5
  *
diff --git a/cake/console/libs/i18n.php b/cake/console/libs/i18n.php
index ad41ec148..bdfa378fb 100644
--- a/cake/console/libs/i18n.php
+++ b/cake/console/libs/i18n.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Internationalization Management Shell
  *
  * PHP versions 4 and 5
  *
diff --git a/cake/console/templates/skel/app_controller.php b/cake/console/templates/skel/app_controller.php
index a1f50257d..c9f09fca0 100644
--- a/cake/console/templates/skel/app_controller.php
+++ b/cake/console/templates/skel/app_controller.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Application level Controller
  *
  * This file is application-wide controller file. You can put all
  * application-wide controller-related methods here.
@@ -22,7 +22,7 @@
  */
 
 /**
- * Short description for class.
+ * Application Controller
  *
  * Add your application-wide methods in the class below, your controllers
  * will inherit them.
diff --git a/cake/console/templates/skel/app_helper.php b/cake/console/templates/skel/app_helper.php
index 9eb974e9e..a64d3cb85 100644
--- a/cake/console/templates/skel/app_helper.php
+++ b/cake/console/templates/skel/app_helper.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Application level View Helper
  *
  * This file is application-wide helper file. You can put all
  * application-wide helper-related methods here.
diff --git a/cake/console/templates/skel/config/acl.ini.php b/cake/console/templates/skel/config/acl.ini.php
index 9a4e5c9fc..075449856 100644
--- a/cake/console/templates/skel/config/acl.ini.php
+++ b/cake/console/templates/skel/config/acl.ini.php
@@ -1,7 +1,7 @@
 ;<?php exit() ?>
 ; SVN FILE: $Id$
 ;/**
-; * Short description for file.
+; * ACL Configuration
 ; *
 ; *
 ; * PHP versions 4 and 5
diff --git a/cake/console/templates/skel/config/routes.php b/cake/console/templates/skel/config/routes.php
index 696c49a87..9e4a28c14 100644
--- a/cake/console/templates/skel/config/routes.php
+++ b/cake/console/templates/skel/config/routes.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Routes Configuration
  *
  * In this file, you set up routes to your controllers and their actions.
  * Routes are very important mechanism that allows you to freely connect
diff --git a/cake/console/templates/skel/webroot/css.php b/cake/console/templates/skel/webroot/css.php
index 83dc90a72..1f04005de 100644
--- a/cake/console/templates/skel/webroot/css.php
+++ b/cake/console/templates/skel/webroot/css.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * CSS Functions
  *
  * PHP versions 4 and 5
  *
diff --git a/cake/libs/controller/app_controller.php b/cake/libs/controller/app_controller.php
index e2a8302c5..073c6405e 100644
--- a/cake/libs/controller/app_controller.php
+++ b/cake/libs/controller/app_controller.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Application level Controller
  *
  * This file is application-wide controller file. You can put all
  * application-wide controller-related methods here.
diff --git a/cake/libs/controller/components/cookie.php b/cake/libs/controller/components/cookie.php
index f5ec59f36..67c3fe4db 100644
--- a/cake/libs/controller/components/cookie.php
+++ b/cake/libs/controller/components/cookie.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Cookie Component
  *
  * PHP versions 4 and 5
  *
diff --git a/cake/libs/controller/components/email.php b/cake/libs/controller/components/email.php
index 5ee9f531f..202f45384 100755
--- a/cake/libs/controller/components/email.php
+++ b/cake/libs/controller/components/email.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Email Component
  *
  * PHP versions 4 and 5
  *
diff --git a/cake/libs/controller/components/security.php b/cake/libs/controller/components/security.php
index 65c00e630..67f83ff52 100644
--- a/cake/libs/controller/components/security.php
+++ b/cake/libs/controller/components/security.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Security Component
  *
  * PHP versions 4 and 5
  *
@@ -18,8 +18,9 @@
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
 App::import('Core', array('String', 'Security'));
+
 /**
- * Short description for file.
+ * SecurityComponent
  *
  * @package       cake
  * @subpackage    cake.cake.libs.controller.components
diff --git a/cake/libs/i18n.php b/cake/libs/i18n.php
index 63f0c80f8..b775223bd 100644
--- a/cake/libs/i18n.php
+++ b/cake/libs/i18n.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Internationalization
  *
  * PHP versions 4 and 5
  *
diff --git a/cake/libs/l10n.php b/cake/libs/l10n.php
index 2ec65bbb8..801112e82 100644
--- a/cake/libs/l10n.php
+++ b/cake/libs/l10n.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Localization
  *
  * PHP versions 4 and 5
  *
@@ -19,7 +19,7 @@
  */
 
 /**
- * Short description for file.
+ * Localization
  *
  * @package       cake
  * @subpackage    cake.cake.libs
diff --git a/cake/libs/model/behaviors/acl.php b/cake/libs/model/behaviors/acl.php
index e1413916e..f044bf42b 100644
--- a/cake/libs/model/behaviors/acl.php
+++ b/cake/libs/model/behaviors/acl.php
@@ -21,7 +21,7 @@
  */
 
 /**
- * Short description for file
+ * ACL behavior
  *
  * @package       cake
  * @subpackage    cake.cake.libs.model.behaviors
diff --git a/cake/libs/model/behaviors/translate.php b/cake/libs/model/behaviors/translate.php
index 53fba8386..39393015d 100644
--- a/cake/libs/model/behaviors/translate.php
+++ b/cake/libs/model/behaviors/translate.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Translate behavior
  *
  * PHP versions 4 and 5
  *
@@ -19,7 +19,7 @@
  */
 
 /**
- * Short description for file.
+ * Translate behavior
  *
  * @package       cake
  * @subpackage    cake.cake.libs.model.behaviors
diff --git a/cake/libs/model/datasources/dbo/dbo_mssql.php b/cake/libs/model/datasources/dbo/dbo_mssql.php
index 8ea2e613d..b7b17f7c8 100644
--- a/cake/libs/model/datasources/dbo/dbo_mssql.php
+++ b/cake/libs/model/datasources/dbo/dbo_mssql.php
@@ -19,7 +19,7 @@
  */
 
 /**
- * Short description for class.
+ * MS SQL layer for DBO
  *
  * Long description for class
  *
diff --git a/cake/libs/model/datasources/dbo/dbo_oracle.php b/cake/libs/model/datasources/dbo/dbo_oracle.php
index b8ee083fa..38fb03382 100644
--- a/cake/libs/model/datasources/dbo/dbo_oracle.php
+++ b/cake/libs/model/datasources/dbo/dbo_oracle.php
@@ -19,7 +19,7 @@
  */
 
 /**
- * Short description for class.
+ * Oracle layer for DBO.
  *
  * Long description for class
  *
diff --git a/cake/libs/model/datasources/dbo_source.php b/cake/libs/model/datasources/dbo_source.php
index 4bd56e849..128b0c309 100755
--- a/cake/libs/model/datasources/dbo_source.php
+++ b/cake/libs/model/datasources/dbo_source.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Dbo Source
  *
  * PHP versions 4 and 5
  *
diff --git a/cake/libs/model/db_acl.php b/cake/libs/model/db_acl.php
index 5dba318f8..245e10b0b 100644
--- a/cake/libs/model/db_acl.php
+++ b/cake/libs/model/db_acl.php
@@ -26,7 +26,7 @@
 App::import('Model', 'App');
 
 /**
- * Short description for file.
+ * ACL Node
  *
  *
  * @package       cake
diff --git a/cake/libs/security.php b/cake/libs/security.php
index b7c5f520b..4020b83ac 100644
--- a/cake/libs/security.php
+++ b/cake/libs/security.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Core Security
  *
  * PHP versions 4 and 5
  *
diff --git a/cake/libs/view/helpers/app_helper.php b/cake/libs/view/helpers/app_helper.php
index 57064f72d..deed26a02 100644
--- a/cake/libs/view/helpers/app_helper.php
+++ b/cake/libs/view/helpers/app_helper.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * Application level View Helper
  *
  * This file is application-wide helper file. You can put all
  * application-wide helper-related methods here.
diff --git a/cake/tests/cases/libs/controller/components/acl.test.php b/cake/tests/cases/libs/controller/components/acl.test.php
index 11faa3aa2..a1f12c6df 100644
--- a/cake/tests/cases/libs/controller/components/acl.test.php
+++ b/cake/tests/cases/libs/controller/components/acl.test.php
@@ -194,7 +194,7 @@ class IniAclTest extends IniAcl {
 }
 
 /**
- * Short description for class.
+ * ACL Component Text case
  *
  * @package       cake
  * @subpackage    cake.tests.cases.libs.controller.components