Numerous 'shoer description' documentation entries updated to contain useful comments.

2025-01-31 09:06:17 +00:00 · 2010-05-30 01:20:28 +10:00 · 2010-05-30 01:20:28 +10:00 · 8decc683ac
commit 8decc683ac
parent f63f15812e
22 changed files with 27 additions and 26 deletions
--- 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
 *
--- 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
 *
--- 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.
--- 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.
--- 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
--- 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
--- 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
 *
--- 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.
--- 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
 *
--- 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
 *
--- 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
--- 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
 *
--- 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
--- 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
--- 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
--- 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
 *
--- 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
 *
--- 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
 *
--- 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
--- 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
 *
--- 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.
--- 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