fixing docs

cakephp · Jun 9, 2011 · 24ba131 · 24ba131
1 parent c7cf04c
commit 24ba131
Show file tree

Hide file tree

Showing 40 changed files with 40 additions and 111 deletions.
diff --git a/Console/Command/BenchmarkShell.php b/Console/Command/BenchmarkShell.php
@@ -5,7 +5,7 @@
  * Provides basic benchmarking of application requests
  * functionally similar to Apache AB
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
@@ -35,7 +35,6 @@ class BenchmarkShell extends Shell {
  * Main execution of shell
  *
  * @return void
- * @access public
  */
 	public function main() {
 		if (empty($this->args) || count($this->args) > 1) {
@@ -67,7 +66,6 @@ public function main() {
  *
  * @param array $times Array of time values
  * @return void
- * @access protected
  */
 	protected function _results($times) {
 		$duration = array_sum($times);
@@ -109,7 +107,6 @@ protected function _results($times) {
  * @param boolean $sample If true, calculates an unbiased estimate of the population
  * 						  variance from a finite sample.
  * @return float Variance
- * @access protected
  */
 	protected function _variance($times, $sample = true) {
 		$n = $mean = $M2 = 0;
@@ -130,7 +127,6 @@ protected function _variance($times, $sample = true) {
  *
  * @param array $times Array of values
  * @return float Standard deviation
- * @access protected
  */
 	protected function _deviation($times, $sample = true) {
 		return sqrt($this->_variance($times, $sample));
@@ -139,7 +135,6 @@ protected function _deviation($times, $sample = true) {
  * Help for Benchmark shell
  *
  * @return void
- * @access public
  */
 	public function help() {
 		$this->out(__d('debug_kit', "DebugKit Benchmark Shell"));

diff --git a/Console/Command/WhitespaceShell.php b/Console/Command/WhitespaceShell.php
@@ -4,7 +4,7 @@
  *
  * Based on jperras' shell found at http://bin.cakephp.org/view/626544881
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)

diff --git a/Controller/Component/ToolbarComponent.php b/Controller/Component/ToolbarComponent.php
@@ -6,7 +6,7 @@
 /**
  * DebugKit DebugToolbar Component
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
@@ -257,7 +257,6 @@ public function loadState($key) {
  * Create the cache config for the history
  *
  * @return void
- * @access protected
  **/
 	protected function _createCacheConfig() {
 		if (Configure::read('Cache.disable') !== true) {
@@ -274,7 +273,6 @@ protected function _createCacheConfig() {
  * collects the panel contents
  *
  * @return array Array of all panel beforeRender()
- * @access protected
  **/
 	protected function _gatherVars($controller) {
 		$vars = array();
@@ -300,7 +298,6 @@ protected function _gatherVars($controller) {
  * Load Panels used in the debug toolbar
  *
  * @return 	void
- * @access protected
  **/
 	protected function _loadPanels($panels, $settings) {
 		foreach ($panels as $panel) {
@@ -324,7 +321,6 @@ protected function _loadPanels($panels, $settings) {
  * This allows DebugView to be compatible with all view classes.
  *
  * @param string $baseClassName
- * @access protected
  * @return void
  */
 	protected function _makeViewClass($baseClassName) {
@@ -356,7 +352,6 @@ protected function _eval($code) {
  *
  * @param object $controller Controller instance
  * @param array $vars Vars to save.
- * @access protected
  * @return void
  **/
 	protected function _saveState($controller, $vars) {
@@ -540,7 +535,6 @@ class SessionPanel extends DebugPanel {
  * beforeRender callback
  *
  * @param object $controller
- * @access public
  * @return array
  */
 	public function beforeRender($controller) {
@@ -628,7 +622,6 @@ class SqlLogPanel extends DebugPanel {
  * Gets the connection names that should have logs + dumps generated.
  *
  * @param string $controller
- * @access public
  * @return void
  */
 	public function beforeRender($controller) {

diff --git a/Controller/DebugKitAppController.php b/Controller/DebugKitAppController.php
@@ -2,7 +2,7 @@
 /**
  * Debug Kit App Controller
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)

diff --git a/Controller/ToolbarAccessController.php b/Controller/ToolbarAccessController.php
@@ -4,7 +4,7 @@
  *
  * Allows retrieval of information from the debugKit internals.
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)

diff --git a/Model/Behavior/TimedBehavior.php b/Model/Behavior/TimedBehavior.php
@@ -2,7 +2,7 @@
 /**
  * DebugKit TimedBehavior
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
@@ -24,15 +24,13 @@ class TimedBehavior extends ModelBehavior {
 /**
  * Behavior settings
  *
- * @access public
  * @var array
  */
 	public $settings = array();
 
 /**
  * Default setting values
  *
- * @access private
  * @var array
  */
 	protected $_defaults = array();
@@ -42,7 +40,6 @@ class TimedBehavior extends ModelBehavior {
  *
  * @param object $Model Model using the behavior
  * @param array $settings Settings to override for model.
- * @access public
  * @return void
  */
 	public function setup($Model, $settings = null) {

diff --git a/Model/DebugKitAppModel.php b/Model/DebugKitAppModel.php
@@ -2,7 +2,7 @@
 /**
  * Debug Kit App Model
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)

diff --git a/Model/ToolbarAccess.php b/Model/ToolbarAccess.php
@@ -4,7 +4,7 @@
  *
  * Contains logic for accessing DebugKit specific information.
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)

diff --git a/README.mdown b/README.mdown
@@ -4,7 +4,7 @@ DebugKit provides a debugging toolbar and enhanced debugging tools for CakePHP a
 
 ## Installation
 
-* Clone/Copy the files in this directory into `app/plugins/debug_kit`
+* Clone/Copy the files in this directory into `app/Plugin/DebugKit`
 * Include the toolbar component in your `app_controller.php`:
    * `public $components = array('DebugKit.Toolbar');`
 * Set debug mode to at least 1.

diff --git a/Test/Case/AllDebugKitTest.php b/Test/Case/AllDebugKitTest.php
@@ -5,7 +5,7 @@
 /**
  * View Group Test for debugkit
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)

diff --git a/Test/Case/AllDebugKitViewTest.php b/Test/Case/AllDebugKitViewTest.php
@@ -5,7 +5,7 @@
 /**
  * View Group Test for debugkit
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)

diff --git a/Test/Case/AllDebugKitWithoutViewTest.php b/Test/Case/AllDebugKitWithoutViewTest.php
@@ -5,7 +5,7 @@
 /**
  * View Group Test for debugkit
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)

diff --git a/Test/Case/Controller/Component/ToolbarComponentTest.php b/Test/Case/Controller/Component/ToolbarComponentTest.php
@@ -3,7 +3,7 @@
 /**
  * DebugToolbar Test
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
@@ -65,7 +65,6 @@ class DebugKitToolbarComponentTestCase extends CakeTestCase {
 /**
  * Start test callback
  *
- * @access public
  * @return void
  **/
 	public function setUp() {
@@ -190,7 +189,6 @@ public function testPluginViewParsing() {
 /**
  * test loading of vendor panels from test_app folder
  *
- * @access public
  * @return void
  */
 	public function testVendorPanels() {
@@ -215,7 +213,6 @@ public function testVendorPanels() {
  * test construct
  *
  * @return void
- * @access public
  **/
 	public function testConstruct() {
 		$this->_loadController();
@@ -232,7 +229,6 @@ public function testConstruct() {
  * test initialize w/ custom panels and defaults
  *
  * @return void
- * @access public
  **/
 	public function testInitializeCustomPanelsWithDefaults() {
 		$this->_loadController(array(

diff --git a/Test/Case/Model/Behavior/TimedBehaviorTest.php b/Test/Case/Model/Behavior/TimedBehaviorTest.php
@@ -2,7 +2,7 @@
 /**
  * DebugKit TimedBehavior test case
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)

diff --git a/Test/Case/Model/ToolbarAccessTest.php b/Test/Case/Model/ToolbarAccessTest.php
@@ -2,7 +2,7 @@
 /**
  * DebugKit ToolbarAccess Model Test case
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)

diff --git a/Test/Case/TestFireCake.php b/Test/Case/TestFireCake.php
@@ -2,7 +2,7 @@
 /**
  * Common test objects used in DebugKit tests
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
@@ -35,7 +35,6 @@ protected function _sendHeader($name, $value) {
 /**
  * skip client detection as headers are not being sent.
  *
- * @access public
  * @return void
  */	
 	public function detectClientExtension() {

diff --git a/Test/Case/Vendor/DebugKitDebuggerTest.php b/Test/Case/Vendor/DebugKitDebuggerTest.php
@@ -2,7 +2,7 @@
 /**
  * DebugKit Debugger Test Case File
  *
- * PHP versions 4 and 5
+ * PHP versions 5
  *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
@@ -30,7 +30,6 @@ class DebugKitDebuggerTest extends CakeTestCase {
 /**
  * setUp method
  *
- * @access public
  * @return void
  */
 	public function setUp() {
@@ -39,7 +38,6 @@ public function setUp() {
 /**
  * tearDown method
  *
- * @access public
  * @return void
  */
 	public function tearDown() {
@@ -147,7 +145,6 @@ public function testRepeatTimers() {
 /**
  * testRequestTime
  *
- * @access public
  * @return void
  */
 	public function testRequestTime() {