Numerous "Enter description here" block comments updated to have meaningful descriptions.

This commit is contained in:
predominant 2010-05-30 01:10:48 +10:00
parent bc3e745673
commit f06f0dae8b
8 changed files with 40 additions and 38 deletions

View file

@ -1,6 +1,6 @@
<?php <?php
/** /**
* Short description for file. * CSS helping functions
* *
* PHP versions 4 and 5 * PHP versions 4 and 5
* *
@ -21,14 +21,16 @@ if (!defined('CAKE_CORE_INCLUDE_PATH')) {
header('HTTP/1.1 404 Not Found'); header('HTTP/1.1 404 Not Found');
exit('File Not Found'); exit('File Not Found');
} }
/** /**
* Enter description here... * Ensure required classes are available.
*/ */
if (!class_exists('File')) { if (!class_exists('File')) {
uses('file'); uses('file');
} }
/** /**
* Enter description here... * Make clean CSS
* *
* @param unknown_type $path * @param unknown_type $path
* @param unknown_type $name * @param unknown_type $name
@ -44,7 +46,7 @@ if (!class_exists('File')) {
return $output; return $output;
} }
/** /**
* Enter description here... * Write CSS cache
* *
* @param unknown_type $path * @param unknown_type $path
* @param unknown_type $content * @param unknown_type $content

View file

@ -23,14 +23,14 @@ if (!defined('CAKE_CORE_INCLUDE_PATH')) {
} }
/** /**
* Enter description here... * Ensure required files are included
*/ */
if (!class_exists('File')) { if (!class_exists('File')) {
require LIBS . 'file.php'; require LIBS . 'file.php';
} }
/** /**
* Enter description here... * Make clean CSS
* *
* @param unknown_type $path * @param unknown_type $path
* @param unknown_type $name * @param unknown_type $name
@ -47,7 +47,7 @@ if (!class_exists('File')) {
} }
/** /**
* Enter description here... * Write CSS cache
* *
* @param unknown_type $path * @param unknown_type $path
* @param unknown_type $content * @param unknown_type $content

View file

@ -91,7 +91,7 @@ class DataSource extends Object {
var $endQuote = null; var $endQuote = null;
/** /**
* Enter description here... * Result
* *
* @var array * @var array
* @access protected * @access protected

View file

@ -507,9 +507,9 @@ class DboMysqlBase extends DboSource {
class DboMysql extends DboMysqlBase { class DboMysql extends DboMysqlBase {
/** /**
* Enter description here... * Datasource description
* *
* @var unknown_type * @var string
*/ */
var $description = "MySQL DBO Driver"; var $description = "MySQL DBO Driver";

View file

@ -30,9 +30,9 @@ App::import('Datasource', 'DboMysql');
class DboMysqli extends DboMysqlBase { class DboMysqli extends DboMysqlBase {
/** /**
* Enter description here... * Datasource Description
* *
* @var unknown_type * @var string
*/ */
var $description = "Mysqli DBO Driver"; var $description = "Mysqli DBO Driver";

View file

@ -29,17 +29,17 @@
class DboOracle extends DboSource { class DboOracle extends DboSource {
/** /**
* Enter description here... * Configuration options
* *
* @var unknown_type * @var array
* @access public * @access public
*/ */
var $config = array(); var $config = array();
/** /**
* Enter description here... * Alias
* *
* @var unknown_type * @var string
*/ */
var $alias = ''; var $alias = '';
@ -56,9 +56,9 @@ class DboOracle extends DboSource {
var $__transactionStarted = false; var $__transactionStarted = false;
/** /**
* Enter description here... * Column definitions
* *
* @var unknown_type * @var array
* @access public * @access public
*/ */
var $columns = array( var $columns = array(
@ -77,25 +77,25 @@ class DboOracle extends DboSource {
'inet' => array('name' => 'inet')); 'inet' => array('name' => 'inet'));
/** /**
* Enter description here... * Connection object
* *
* @var unknown_type * @var mixed
* @access protected * @access protected
*/ */
var $connection; var $connection;
/** /**
* Enter description here... * Query limit
* *
* @var unknown_type * @var int
* @access protected * @access protected
*/ */
var $_limit = -1; var $_limit = -1;
/** /**
* Enter description here... * Query offset
* *
* @var unknown_type * @var int
* @access protected * @access protected
*/ */
var $_offset = 0; var $_offset = 0;
@ -109,25 +109,25 @@ class DboOracle extends DboSource {
var $_map; var $_map;
/** /**
* Enter description here... * Current Row
* *
* @var unknown_type * @var mixed
* @access protected * @access protected
*/ */
var $_currentRow; var $_currentRow;
/** /**
* Enter description here... * Number of rows
* *
* @var unknown_type * @var int
* @access protected * @access protected
*/ */
var $_numRows; var $_numRows;
/** /**
* Enter description here... * Query results
* *
* @var unknown_type * @var mixed
* @access protected * @access protected
*/ */
var $_results; var $_results;
@ -378,9 +378,9 @@ class DboOracle extends DboSource {
} }
/** /**
* Enter description here... * Fetch result row
* *
* @return unknown * @return array
* @access public * @access public
*/ */
function fetchRow() { function fetchRow() {
@ -444,10 +444,10 @@ class DboOracle extends DboSource {
} }
/** /**
* Enter description here... * Create trigger
* *
* @param unknown_type $table * @param string $table
* @return unknown * @return mixed
* @access public * @access public
*/ */
function createTrigger($table) { function createTrigger($table) {

View file

@ -29,9 +29,9 @@
class DboSqlite extends DboSource { class DboSqlite extends DboSource {
/** /**
* Enter description here... * Datasource Description
* *
* @var unknown_type * @var string
*/ */
var $description = "SQLite DBO Driver"; var $description = "SQLite DBO Driver";

View file

@ -69,7 +69,7 @@ class NumberHelper extends AppHelper {
* *
* @param float $number A floating point number. * @param float $number A floating point number.
* @param integer $precision The precision of the returned number. * @param integer $precision The precision of the returned number.
* @return float Enter description here... * @return float Formatted float.
* @access public * @access public
* @link http://book.cakephp.org/view/1454/precision * @link http://book.cakephp.org/view/1454/precision
*/ */