Browse Source

doc block corrections

euromark 12 years ago
parent
commit
ba02678693

+ 4 - 4
lib/Cake/Log/CakeLog.php

@@ -255,8 +255,8 @@ class CakeLog {
  * }}}
  *
  * @param array $levels array
- * @param bool $append true to append, false to replace
- * @return array active log levels
+ * @param boolean $append true to append, false to replace
+ * @return array Active log levels
  */
 	public static function levels($levels = array(), $append = true) {
 		if (empty(self::$_Collection)) {
@@ -278,7 +278,7 @@ class CakeLog {
 /**
  * Reset log levels to the original value
  *
- * @return array default log levels
+ * @return array Default log levels
  */
 	public static function defaultLevels() {
 		self::$_levelMap = self::$_defaultLevels;
@@ -304,7 +304,7 @@ class CakeLog {
  * Checks whether $streamName is enabled
  *
  * @param string $streamName to check
- * @return bool
+ * @return boolean
  * @throws CakeLogException
  */
 	public static function enabled($streamName) {

+ 1 - 1
lib/Cake/Network/CakeRequest.php

@@ -673,7 +673,7 @@ class CakeRequest implements ArrayAccess {
  *
  * @param integer $tldLength Number of segments your tld contains. For example: `example.com` contains 1 tld.
  *   While `example.co.uk` contains 2.
- * @return array of subdomains.
+ * @return array An array of subdomains.
  */
 	public function subdomains($tldLength = 1) {
 		$segments = explode('.', $this->host());

+ 1 - 1
lib/Cake/Test/Case/Controller/Component/Acl/DbAclTest.php

@@ -498,7 +498,7 @@ class DbAclTest extends CakeTestCase {
  * Generates a list of the current aro and aco structures and a grid dump of the permissions that are defined
  * Only designed to work with the db based ACL
  *
- * @param bool $treesToo
+ * @param boolean $treesToo
  * @return void
  */
 	protected function _debug($printTreesToo = false) {

+ 3 - 3
lib/Cake/Test/Case/Model/BehaviorCollectionTest.php

@@ -184,7 +184,7 @@ class TestBehavior extends ModelBehavior {
  * afterValidate method
  *
  * @param Model $model
- * @param bool $cascade
+ * @param boolean $cascade
  * @return void
  */
 	public function afterValidate(Model $model) {
@@ -205,7 +205,7 @@ class TestBehavior extends ModelBehavior {
  * beforeDelete method
  *
  * @param Model $model
- * @param bool $cascade
+ * @param boolean $cascade
  * @return void
  */
 	public function beforeDelete(Model $model, $cascade = true) {
@@ -277,7 +277,7 @@ class TestBehavior extends ModelBehavior {
  * testMethod method
  *
  * @param Model $model
- * @param bool $param
+ * @param boolean $param
  * @return void
  */
 	public function testMethod(Model $model, $param = true) {

+ 1 - 1
lib/Cake/Test/Case/Model/models.php

@@ -2547,7 +2547,7 @@ class NumberTree extends CakeTestModel {
  * @param mixed $currentLevel
  * @param mixed $parent_id
  * @param string $prefix
- * @param bool $hierarchal
+ * @param boolean $hierarchal
  * @return void
  */
 	public function initialize($levelLimit = 3, $childLimit = 3, $currentLevel = null, $parentId = null, $prefix = '1', $hierarchal = true) {

+ 3 - 1
lib/Cake/Test/Case/Network/CakeRequestTest.php

@@ -33,7 +33,8 @@ class TestCakeRequest extends CakeRequest {
  * reConstruct method
  *
  * @param string $url
- * @param bool $parseEnvironment
+ * @param boolean $parseEnvironment
+ * @return void
  */
 	public function reConstruct($url = 'some/path', $parseEnvironment = true) {
 		$this->_base();
@@ -2105,6 +2106,7 @@ XML;
 /**
  * Test onlyAllow throwing exception
  *
+ * @return void
  */
 	public function testOnlyAllowException() {
 		$_SERVER['REQUEST_METHOD'] = 'PUT';

+ 1 - 1
lib/Cake/Test/Case/Utility/FileTest.php

@@ -543,7 +543,7 @@ class FileTest extends CakeTestCase {
 /**
  * getTmpFile method
  *
- * @param bool $paintSkip
+ * @param boolean $paintSkip
  * @return void
  */
 	protected function _getTmpFile($paintSkip = true) {