From 8110aed1b1ce466df1d7ea10cc5392b45c0a3503 Mon Sep 17 00:00:00 2001
From: Mark Story <mark@mark-story.com>
Date: Wed, 6 Jan 2010 21:27:14 -0500
Subject: [PATCH] Updating doc blocks for App and Configure.

---
 cake/libs/configure.php | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/cake/libs/configure.php b/cake/libs/configure.php
index 6558a9066..524f4d2fb 100644
--- a/cake/libs/configure.php
+++ b/cake/libs/configure.php
@@ -450,7 +450,7 @@ class Configure extends Object {
 }
 
 /**
- * Class and file loader.
+ * Class/file loader and path management.
  *
  * @link          http://book.cakephp.org/view/499/The-App-Class
  * @since         CakePHP(tm) v 1.2.0.6001
@@ -634,8 +634,9 @@ class App extends Object {
 /**
  * Used to read information stored path
  *
- * Usage
- * App::path('models'); will return all paths for models
+ * Usage:
+ *
+ * `App::path('models'); will return all paths for models`
  *
  * @param string $type type of path
  * @return string array
@@ -731,7 +732,7 @@ class App extends Object {
  * Passing $type only returns the values for a given value of $key.
  *
  * @param string $type valid values are: 'model', 'behavior', 'controller', 'component',
- *                      'view', 'helper', 'datasource', 'libs', and 'cake'
+ *    'view', 'helper', 'datasource', 'libs', and 'cake'
  * @return array numeric keyed array of core lib paths
  * @access public
  */
@@ -783,9 +784,11 @@ class App extends Object {
 /**
  * Returns an index of objects of the given type, with the physical path to each object.
  *
- * @param string	$type Type of object, i.e. 'model', 'controller', 'helper', or 'plugin'
- * @param mixed		$path Optional
- * @return Configure instance
+ * @param string $type Type of object, i.e. 'model', 'controller', 'helper', or 'plugin'
+ * @param mixed $path Optional Scan only the path given. If null, paths for the chosen
+ *   type will be used.
+ * @param boolean $cache Set to false to rescan objects of the chosen type. Defaults to true.
+ * @return mixed Either false on incorrect / miss.  Or an array of found objects.
  * @access public
  */
 	function objects($type, $path = null, $cache = true) {
@@ -1072,6 +1075,7 @@ class App extends Object {
  * @param string $name unique name for this map
  * @param string $type type object being mapped
  * @param string $plugin camelized if object is from a plugin, the name of the plugin
+ * @return void
  * @access private
  */
 	function __map($file, $name, $type, $plugin) {
@@ -1252,6 +1256,7 @@ class App extends Object {
  * @param string $path Path to scan for files
  * @param string $suffix if false, return only directories. if string, match and return files
  * @return array  List of directories or files in directory
+ * @access private
  */
 	function __list($path, $suffix = false, $extension = false) {
 		if (!class_exists('Folder')) {