Browse Source

Fixed doc block comments.

Majna 14 years ago
parent
commit
a5220fa7bb

+ 0 - 1
app/Config/acl.ini.php

@@ -1,5 +1,4 @@
 ;<?php exit() ?>
-; SVN FILE: $Id$
 ;/**
 ; * ACL Configuration
 ; *

+ 1 - 1
lib/Cake/Console/Command/CommandListShell.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * CommandListTest file
+ * Command list Shell
  *
  * PHP 5
  *

+ 1 - 1
lib/Cake/Console/Templates/default/views/home.ctp

@@ -101,7 +101,7 @@ if (isset(\$filePresent)):
 		echo '</span></p>';
 	}
 ?>\n";
-$output .= "<h3><?php echo __d('cake_dev', 'Editing this Page') ?></h3>\n";
+$output .= "<h3><?php echo __d('cake_dev', 'Editing this Page'); ?></h3>\n";
 $output .= "<p>\n";
 $output .= "<?php\n";
 $output .= "\techo __d('cake_dev', 'To change the content of this page, edit: %s\n";

+ 0 - 1
lib/Cake/Console/Templates/skel/Config/acl.ini.php

@@ -1,5 +1,4 @@
 ;<?php exit() ?>
-; SVN FILE: $Id$
 ;/**
 ; * ACL Configuration
 ; *

+ 10 - 10
lib/Cake/Console/Templates/skel/Config/bootstrap.php

@@ -30,16 +30,16 @@ Cache::config('default', array('engine' => 'File'));
  * The settings below can be used to set additional paths to models, views and controllers.
  *
  * App::build(array(
- *     'plugins' => array('/full/path/to/plugins/', '/next/full/path/to/plugins/'),
- *     'models' =>  array('/full/path/to/models/', '/next/full/path/to/models/'),
- *     'views' => array('/full/path/to/views/', '/next/full/path/to/views/'),
- *     'controllers' => array('/full/path/to/controllers/', '/next/full/path/to/controllers/'),
- *     'datasources' => array('/full/path/to/datasources/', '/next/full/path/to/datasources/'),
- *     'behaviors' => array('/full/path/to/behaviors/', '/next/full/path/to/behaviors/'),
- *     'components' => array('/full/path/to/components/', '/next/full/path/to/components/'),
- *     'helpers' => array('/full/path/to/helpers/', '/next/full/path/to/helpers/'),
- *     'vendors' => array('/full/path/to/vendors/', '/next/full/path/to/vendors/'),
- *     'shells' => array('/full/path/to/shells/', '/next/full/path/to/shells/'),
+ *     'Plugin' => array('/full/path/to/plugins/', '/next/full/path/to/plugins/'),
+ *     'Model' =>  array('/full/path/to/models/', '/next/full/path/to/models/'),
+ *     'View' => array('/full/path/to/views/', '/next/full/path/to/views/'),
+ *     'Controller' => array('/full/path/to/controllers/', '/next/full/path/to/controllers/'),
+ *     'Model/Datasource' => array('/full/path/to/datasources/', '/next/full/path/to/datasources/'),
+ *     'Model/Behavior' => array('/full/path/to/behaviors/', '/next/full/path/to/behaviors/'),
+ *     'Controller/Component' => array('/full/path/to/components/', '/next/full/path/to/components/'),
+ *     'View/Helper' => array('/full/path/to/helpers/', '/next/full/path/to/helpers/'),
+ *     'Vendor' => array('/full/path/to/vendors/', '/next/full/path/to/vendors/'),
+ *     'Console/Command' => array('/full/path/to/shells/', '/next/full/path/to/shells/'),
  *     'locales' => array('/full/path/to/locale/', '/next/full/path/to/locale/')
  * ));
  *

+ 1 - 1
lib/Cake/Console/Templates/skel/Config/core.php

@@ -196,7 +196,7 @@
  * Will append a querystring parameter containing the time the file was modified. This is
  * useful for invalidating browser caches.
  *
- * Set to `true` to apply timestamps, when debug = 0, or set to 'force' to always enable
+ * Set to `true` to apply timestamps, when debug > 0, or set to 'force' to always enable
  * timestamping.
  */
 	//Configure::write('Asset.timestamp', true);

+ 1 - 1
lib/Cake/Console/Templates/skel/View/Helper/AppHelper.php

@@ -22,7 +22,7 @@ App::uses('Helper', 'View');
 
 /**
  * This is a placeholder class.
- * Create the same file in app/app_helper.php
+ * Create the same file in app/View/Helper/AppHelper.php
  *
  * Add your application-wide methods in the class below, your helpers
  * will inherit them.

+ 1 - 1
lib/Cake/Model/AppModel.php

@@ -26,7 +26,7 @@ App::uses('Model', 'Model');
  * Application model for Cake.
  *
  * This is a placeholder class.
- * Create the same file in app/app_model.php
+ * Create the same file in app/Model/AppModel.php
  * Add your application-wide methods to the class, your models will inherit them.
  *
  * @package       Cake.Model

+ 5 - 0
lib/Cake/Network/Http/HttpResponse.php

@@ -17,6 +17,11 @@
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
 
+/**
+ * HTTP Response
+ *
+ * @package       Cake.Network.Http
+ */
 class HttpResponse implements ArrayAccess {
 
 /**

+ 1 - 1
lib/Cake/Utility/Debugger.php

@@ -606,7 +606,7 @@ class Debugger {
  *    straight HTML output, or 'txt' for unformatted text.
  * @param array $strings Template strings to be used for the output format.
  * @return string
- * @deprecated Use Debugger::outputFormat() and  Debugger::addFormat(). Will be removed 
+ * @deprecated Use Debugger::outputAs() and  Debugger::addFormat(). Will be removed 
  *   in 3.0
  */
 	public function output($format = null, $strings = array()) {

+ 3 - 3
lib/Cake/Utility/File.php

@@ -45,7 +45,7 @@ class File {
 	public $name = null;
 
 /**
- * file info
+ * File info
  *
  * @var string
  */
@@ -59,14 +59,14 @@ class File {
 	public $handle = null;
 
 /**
- * enable locking for file reading and writing
+ * Enable locking for file reading and writing
  *
  * @var boolean
  */
 	public $lock = null;
 
 /**
- * path property
+ * Path property
  *
  * Current file's absolute path
  *

+ 1 - 1
lib/Cake/View/Helper/AppHelper.php

@@ -23,7 +23,7 @@ App::uses('Helper', 'View');
 
 /**
  * This is a placeholder class.
- * Create the same file in app/app_helper.php
+ * Create the same file in app/View/Helper/AppHelper.php
  *
  * Add your application-wide methods in the class below, your helpers
  * will inherit them.

+ 1 - 0
lib/Cake/View/Helper/HtmlHelper.php

@@ -308,6 +308,7 @@ class HtmlHelper extends AppHelper {
  * ### Options
  *
  * - `escape` Set to false to disable escaping of title and attributes.
+ * - `confirm` JavaScript confirmation message.
  *
  * @param string $title The content to be wrapped by <a> tags.
  * @param mixed $url Cake-relative URL or array of URL parameters, or external URL (starts with http://)

+ 1 - 1
lib/Cake/View/Helper/JsHelper.php

@@ -40,7 +40,7 @@ class JsHelper extends AppHelper {
 	public $bufferScripts = true;
 
 /**
- * helpers
+ * Helper dependencies
  *
  * @var array
  */