From f06f0dae8be7be2cf6ed571d5e46c58959814f53 Mon Sep 17 00:00:00 2001
From: predominant <graham@grahamweldon.com>
Date: Sun, 30 May 2010 01:10:48 +1000
Subject: [PATCH] Numerous "Enter description here" block comments updated to
 have meaningful descriptions.

---
 app/webroot/css.php                           | 10 ++--
 cake/console/templates/skel/webroot/css.php   |  6 +--
 cake/libs/model/datasources/datasource.php    |  2 +-
 cake/libs/model/datasources/dbo/dbo_mysql.php |  4 +-
 .../libs/model/datasources/dbo/dbo_mysqli.php |  4 +-
 .../libs/model/datasources/dbo/dbo_oracle.php | 46 +++++++++----------
 .../libs/model/datasources/dbo/dbo_sqlite.php |  4 +-
 cake/libs/view/helpers/number.php             |  2 +-
 8 files changed, 40 insertions(+), 38 deletions(-)

diff --git a/app/webroot/css.php b/app/webroot/css.php
index 445b2fb2e37..aae68cba824 100644
--- a/app/webroot/css.php
+++ b/app/webroot/css.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Short description for file.
+ * CSS helping functions
  *
  * PHP versions 4 and 5
  *
@@ -21,14 +21,16 @@
 	header('HTTP/1.1 404 Not Found');
 	exit('File Not Found');
 }
+
 /**
- * Enter description here...
+ * Ensure required classes are available.
  */
 if (!class_exists('File')) {
 	uses('file');
 }
+
 /**
- * Enter description here...
+ * Make clean CSS
  *
  * @param unknown_type $path
  * @param unknown_type $name
@@ -44,7 +46,7 @@ function make_clean_css($path, $name) {
 		return $output;
 	}
 /**
- * Enter description here...
+ * Write CSS cache
  *
  * @param unknown_type $path
  * @param unknown_type $content
diff --git a/cake/console/templates/skel/webroot/css.php b/cake/console/templates/skel/webroot/css.php
index 464f20987c1..83dc90a7246 100644
--- a/cake/console/templates/skel/webroot/css.php
+++ b/cake/console/templates/skel/webroot/css.php
@@ -23,14 +23,14 @@
 }
 
 /**
- * Enter description here...
+ * Ensure required files are included
  */
 if (!class_exists('File')) {
 	require LIBS . 'file.php';
 }
 
 /**
- * Enter description here...
+ * Make clean CSS
  *
  * @param unknown_type $path
  * @param unknown_type $name
@@ -47,7 +47,7 @@ function make_clean_css($path, $name) {
 	}
 
 /**
- * Enter description here...
+ * Write CSS cache
  *
  * @param unknown_type $path
  * @param unknown_type $content
diff --git a/cake/libs/model/datasources/datasource.php b/cake/libs/model/datasources/datasource.php
index ab45610b151..2c5a0ab125a 100644
--- a/cake/libs/model/datasources/datasource.php
+++ b/cake/libs/model/datasources/datasource.php
@@ -91,7 +91,7 @@ class DataSource extends Object {
 	var $endQuote = null;
 
 /**
- * Enter description here...
+ * Result
  *
  * @var array
  * @access protected
diff --git a/cake/libs/model/datasources/dbo/dbo_mysql.php b/cake/libs/model/datasources/dbo/dbo_mysql.php
index d06d71830f7..731e14e704d 100644
--- a/cake/libs/model/datasources/dbo/dbo_mysql.php
+++ b/cake/libs/model/datasources/dbo/dbo_mysql.php
@@ -507,9 +507,9 @@ function column($real) {
 class DboMysql extends DboMysqlBase {
 
 /**
- * Enter description here...
+ * Datasource description
  *
- * @var unknown_type
+ * @var string
  */
 	var $description = "MySQL DBO Driver";
 
diff --git a/cake/libs/model/datasources/dbo/dbo_mysqli.php b/cake/libs/model/datasources/dbo/dbo_mysqli.php
index d42b10eda07..daf47f557c4 100644
--- a/cake/libs/model/datasources/dbo/dbo_mysqli.php
+++ b/cake/libs/model/datasources/dbo/dbo_mysqli.php
@@ -30,9 +30,9 @@
 class DboMysqli extends DboMysqlBase {
 
 /**
- * Enter description here...
+ * Datasource Description
  *
- * @var unknown_type
+ * @var string
  */
 	var $description = "Mysqli DBO Driver";
 
diff --git a/cake/libs/model/datasources/dbo/dbo_oracle.php b/cake/libs/model/datasources/dbo/dbo_oracle.php
index 9c78d4f750e..b8ee083fa6e 100644
--- a/cake/libs/model/datasources/dbo/dbo_oracle.php
+++ b/cake/libs/model/datasources/dbo/dbo_oracle.php
@@ -29,17 +29,17 @@
 class DboOracle extends DboSource {
 
 /**
- * Enter description here...
+ * Configuration options
  *
- * @var unknown_type
+ * @var array
  * @access public
  */
 	var $config = array();
 
 /**
- * Enter description here...
+ * Alias
  *
- * @var unknown_type
+ * @var string
  */
 	var $alias = '';
 
@@ -56,9 +56,9 @@ class DboOracle extends DboSource {
 	var $__transactionStarted = false;
 
 /**
- * Enter description here...
+ * Column definitions
  *
- * @var unknown_type
+ * @var array
  * @access public
  */
 	var $columns = array(
@@ -77,25 +77,25 @@ class DboOracle extends DboSource {
 		'inet' => array('name' => 'inet'));
 
 /**
- * Enter description here...
+ * Connection object
  *
- * @var unknown_type
+ * @var mixed
  * @access protected
  */
 	var $connection;
 
 /**
- * Enter description here...
+ * Query limit
  *
- * @var unknown_type
+ * @var int
  * @access protected
  */
 	var $_limit = -1;
 
 /**
- * Enter description here...
+ * Query offset
  *
- * @var unknown_type
+ * @var int
  * @access protected
  */
 	var $_offset = 0;
@@ -109,25 +109,25 @@ class DboOracle extends DboSource {
 	var $_map;
 
 /**
- * Enter description here...
+ * Current Row
  *
- * @var unknown_type
+ * @var mixed
  * @access protected
  */
 	var $_currentRow;
 
 /**
- * Enter description here...
+ * Number of rows
  *
- * @var unknown_type
+ * @var int
  * @access protected
  */
 	var $_numRows;
 
 /**
- * Enter description here...
+ * Query results
  *
- * @var unknown_type
+ * @var mixed
  * @access protected
  */
 	var $_results;
@@ -378,9 +378,9 @@ function _execute($sql) {
 	}
 
 /**
- * Enter description here...
+ * Fetch result row
  *
- * @return unknown
+ * @return array
  * @access public
  */
 	function fetchRow() {
@@ -444,10 +444,10 @@ function createSequence($sequence) {
 	}
 
 /**
- * Enter description here...
+ * Create trigger
  *
- * @param unknown_type $table
- * @return unknown
+ * @param string $table
+ * @return mixed
  * @access public
  */
 	function createTrigger($table) {
diff --git a/cake/libs/model/datasources/dbo/dbo_sqlite.php b/cake/libs/model/datasources/dbo/dbo_sqlite.php
index 1fdba32a8d4..efc660f33b8 100644
--- a/cake/libs/model/datasources/dbo/dbo_sqlite.php
+++ b/cake/libs/model/datasources/dbo/dbo_sqlite.php
@@ -29,9 +29,9 @@
 class DboSqlite extends DboSource {
 
 /**
- * Enter description here...
+ * Datasource Description
  *
- * @var unknown_type
+ * @var string
  */
 	var $description = "SQLite DBO Driver";
 
diff --git a/cake/libs/view/helpers/number.php b/cake/libs/view/helpers/number.php
index da8a565a65f..236732a927f 100644
--- a/cake/libs/view/helpers/number.php
+++ b/cake/libs/view/helpers/number.php
@@ -69,7 +69,7 @@ class NumberHelper extends AppHelper {
  *
  * @param float $number	A floating point number.
  * @param integer $precision The precision of the returned number.
- * @return float Enter description here...
+ * @return float Formatted float.
  * @access public
  * @link http://book.cakephp.org/view/1454/precision
  */