From 9f601ea334e6bd7b1b2b426f1c0b0a6a5340d2a1 Mon Sep 17 00:00:00 2001
From: sdoney <sdoney@gmail.com>
Date: Sun, 4 Apr 2010 23:31:50 -0400
Subject: [PATCH] Adding/Updating @link tags pointing to cookbook sections

Signed-off-by: Mark Story <mark@mark-story.com>
---
 cake/basics.php                           |  3 +++
 cake/console/libs/schema.php              |  2 +-
 cake/libs/configure.php                   |  2 +-
 cake/libs/controller/app_controller.php   |  1 +
 cake/libs/controller/pages_controller.php |  1 +
 cake/libs/model/behaviors/acl.php         |  2 ++
 cake/libs/model/behaviors/containable.php |  2 ++
 cake/libs/model/behaviors/translate.php   |  1 +
 cake/libs/model/behaviors/tree.php        | 13 +++++++++++++
 cake/libs/model/model.php                 |  2 +-
 10 files changed, 26 insertions(+), 3 deletions(-)

diff --git a/cake/basics.php b/cake/basics.php
index e58eec6e69b..d259edf91ec 100644
--- a/cake/basics.php
+++ b/cake/basics.php
@@ -52,6 +52,7 @@ function clone($object)
  * `config('config1', 'config2');`
  *
  * @return boolean Success
+ * @link http://book.cakephp.org/view/1125/config
  */
 	function config() {
 		$args = func_get_args();
@@ -82,6 +83,7 @@ function config() {
  *
  * @param string $name Filename without the .php part
  * @deprecated Will be removed in 2.0
+ * @link http://book.cakephp.org/view/1140/uses
  */
 	function uses() {
 		$args = func_get_args();
@@ -99,6 +101,7 @@ function uses() {
  * @param boolean $showHtml If set to true, the method prints the debug data in a screen-friendly way.
  * @param boolean $showFrom If set to true, the method prints from where the function was called.
  * @link http://book.cakephp.org/view/1190/Basic-Debugging
+ * @link http://book.cakephp.org/view/1128/debug
  */
 	function debug($var = false, $showHtml = false, $showFrom = true) {
 		if (Configure::read() > 0) {
diff --git a/cake/console/libs/schema.php b/cake/console/libs/schema.php
index b8efe2a55f1..e835854179b 100644
--- a/cake/console/libs/schema.php
+++ b/cake/console/libs/schema.php
@@ -28,7 +28,7 @@
  *
  * @package       cake
  * @subpackage    cake.cake.console.libs
- * @link          http://book.cakephp.org/view/1523s/Schema-management-and-migrations
+ * @link          http://book.cakephp.org/view/1523/Schema-management-and-migrations
  */
 class SchemaShell extends Shell {
 
diff --git a/cake/libs/configure.php b/cake/libs/configure.php
index 802ed1c3b4e..d42e0eafacb 100644
--- a/cake/libs/configure.php
+++ b/cake/libs/configure.php
@@ -439,7 +439,7 @@ function __loadBootstrap($boot) {
 /**
  * Class/file loader and path management.
  *
- * @link          http://book.cakephp.org/view/499/The-App-Class
+ * @link          http://book.cakephp.org/view/933/The-App-Class
  * @since         CakePHP(tm) v 1.2.0.6001
  * @package       cake
  * @subpackage    cake.cake.libs
diff --git a/cake/libs/controller/app_controller.php b/cake/libs/controller/app_controller.php
index ef3fe6c35c6..5abaac2ad49 100644
--- a/cake/libs/controller/app_controller.php
+++ b/cake/libs/controller/app_controller.php
@@ -30,6 +30,7 @@
  *
  * @package       cake
  * @subpackage    cake.cake.libs.controller
+ * @link http://book.cakephp.org/view/957/The-App-Controller
  */
 class AppController extends Controller {
 }
diff --git a/cake/libs/controller/pages_controller.php b/cake/libs/controller/pages_controller.php
index b26f71a74c9..d22e1bb9a96 100644
--- a/cake/libs/controller/pages_controller.php
+++ b/cake/libs/controller/pages_controller.php
@@ -27,6 +27,7 @@
  *
  * @package       cake
  * @subpackage    cake.cake.libs.controller
+ * @link http://book.cakephp.org/view/958/The-Pages-Controller
  */
 class PagesController extends AppController {
 
diff --git a/cake/libs/model/behaviors/acl.php b/cake/libs/model/behaviors/acl.php
index 3bc033b6109..94f8025e698 100644
--- a/cake/libs/model/behaviors/acl.php
+++ b/cake/libs/model/behaviors/acl.php
@@ -25,6 +25,7 @@
  *
  * @package       cake
  * @subpackage    cake.cake.libs.model.behaviors
+ * @link http://book.cakephp.org/view/1320/ACL
  */
 class AclBehavior extends ModelBehavior {
 
@@ -69,6 +70,7 @@ function setup(&$model, $config = array()) {
  * @param mixed $ref
  * @return array
  * @access public
+ * @link http://book.cakephp.org/view/1322/node
  */
 	function node(&$model, $ref = null) {
 		$type = $this->__typeMaps[strtolower($this->settings[$model->name]['type'])];
diff --git a/cake/libs/model/behaviors/containable.php b/cake/libs/model/behaviors/containable.php
index 31cd48672f6..170c78f5f06 100644
--- a/cake/libs/model/behaviors/containable.php
+++ b/cake/libs/model/behaviors/containable.php
@@ -26,6 +26,7 @@
  *
  * @package       cake
  * @subpackage    cake.cake.console.libs
+ * @link http://book.cakephp.org/view/1323/Containable
  */
 class ContainableBehavior extends ModelBehavior {
 
@@ -234,6 +235,7 @@ function afterFind(&$Model, $results, $primary) {
  * @param object $Model Model on which binding restriction is being applied
  * @return void
  * @access public
+ * @link http://book.cakephp.org/view/1323/Containable#Using-Containable-1324
  */
 	function contain(&$Model) {
 		$args = func_get_args();
diff --git a/cake/libs/model/behaviors/translate.php b/cake/libs/model/behaviors/translate.php
index f9cfed4caf4..8b79938a036 100644
--- a/cake/libs/model/behaviors/translate.php
+++ b/cake/libs/model/behaviors/translate.php
@@ -23,6 +23,7 @@
  *
  * @package       cake
  * @subpackage    cake.cake.libs.model.behaviors
+ * @link http://book.cakephp.org/view/1328/Translate
  */
 class TranslateBehavior extends ModelBehavior {
 
diff --git a/cake/libs/model/behaviors/tree.php b/cake/libs/model/behaviors/tree.php
index 349dcd5ebd2..44f97ac19d5 100644
--- a/cake/libs/model/behaviors/tree.php
+++ b/cake/libs/model/behaviors/tree.php
@@ -28,6 +28,7 @@
  * @see http://en.wikipedia.org/wiki/Tree_traversal
  * @package       cake
  * @subpackage    cake.cake.libs.model.behaviors
+ * @link http://book.cakephp.org/view/1339/Tree
  */
 class TreeBehavior extends ModelBehavior {
 
@@ -206,6 +207,7 @@ function beforeSave(&$Model) {
  * @param boolean $direct whether to count direct, or all, children
  * @return integer number of child nodes
  * @access public
+ * @link http://book.cakephp.org/view/1347/Counting-children
  */
 	function childcount(&$Model, $id = null, $direct = false) {
 		if (is_array($id)) {
@@ -252,6 +254,7 @@ function childcount(&$Model, $id = null, $direct = false) {
  * @param integer $recursive The number of levels deep to fetch associated records
  * @return array Array of child nodes
  * @access public
+ * @link http://book.cakephp.org/view/1346/Children
  */
 	function children(&$Model, $id = null, $direct = false, $fields = null, $order = null, $limit = null, $page = 1, $recursive = null) {
 		if (is_array($id)) {
@@ -309,6 +312,7 @@ function children(&$Model, $id = null, $direct = false, $fields = null, $order =
  * @param integer $recursive The number of levels deep to fetch associated records
  * @return array An associative array of records, where the id is the key, and the display field is the value
  * @access public
+ * @link http://book.cakephp.org/view/1348/generatetreelist
  */
 	function generatetreelist(&$Model, $conditions = null, $keyPath = null, $valuePath = null, $spacer = '_', $recursive = null) {
 		$overrideRecursive = $recursive;
@@ -364,6 +368,7 @@ function generatetreelist(&$Model, $conditions = null, $keyPath = null, $valuePa
  * @param integer $recursive The number of levels deep to fetch associated records
  * @return array Array of data for the parent node
  * @access public
+ * @link http://book.cakephp.org/view/1349/getparentnode
  */
 	function getparentnode(&$Model, $id = null, $fields = null, $recursive = null) {
 		if (is_array($id)) {
@@ -397,6 +402,7 @@ function getparentnode(&$Model, $id = null, $fields = null, $recursive = null) {
  * @param integer $recursive The number of levels deep to fetch associated records
  * @return array Array of nodes from top most parent to current node
  * @access public
+ * @link http://book.cakephp.org/view/1350/getpath
  */
 	function getpath(&$Model, $id = null, $fields = null, $recursive = null) {
 		if (is_array($id)) {
@@ -434,6 +440,7 @@ function getpath(&$Model, $id = null, $fields = null, $recursive = null) {
  * @param mixed $number how many places to move the node or true to move to last position
  * @return boolean true on success, false on failure
  * @access public
+ * @link http://book.cakephp.org/view/1352/moveDown
  */
 	function movedown(&$Model, $id = null, $number = 1) {
 		if (is_array($id)) {
@@ -492,6 +499,7 @@ function movedown(&$Model, $id = null, $number = 1) {
  * @param mixed $number how many places to move the node, or true to move to first position
  * @return boolean true on success, false on failure
  * @access public
+ * @link http://book.cakephp.org/view/1353/moveUp
  */
 	function moveup(&$Model, $id = null, $number = 1) {
 		if (is_array($id)) {
@@ -556,6 +564,7 @@ function moveup(&$Model, $id = null, $number = 1) {
  * delete, or the id of the parent to set as the parent_id
  * @return boolean true on success, false on failure
  * @access public
+ * @link http://book.cakephp.org/view/1628/Recover
  */
 	function recover(&$Model, $mode = 'parent', $missingParentAction = null) {
 		if (is_array($mode)) {
@@ -634,6 +643,8 @@ function recover(&$Model, $mode = 'parent', $missingParentAction = null) {
  * @param AppModel $Model Model instance
  * @param array $options array of options to use in reordering.
  * @return boolean true on success, false on failure
+ * @link http://book.cakephp.org/view/1355/reorder
+ * @link http://book.cakephp.org/view/1629/Reorder
  */
 	function reorder(&$Model, $options = array()) {
 		$options = array_merge(array('id' => null, 'field' => $Model->displayField, 'order' => 'ASC', 'verify' => true), $options);
@@ -673,6 +684,7 @@ function reorder(&$Model, $options = array()) {
  * @param boolean $delete whether to delete the node after reparenting children (if any)
  * @return boolean true on success, false on failure
  * @access public
+ * @link http://book.cakephp.org/view/1354/removeFromTree
  */
 	function removefromtree(&$Model, $id = null, $delete = false) {
 		if (is_array($id)) {
@@ -741,6 +753,7 @@ function removefromtree(&$Model, $id = null, $delete = false) {
  * @return mixed true if the tree is valid or empty, otherwise an array of (error type [index, node],
  *  [incorrect left/right index,node id], message)
  * @access public
+ * @link http://book.cakephp.org/view/1630/Verify
  */
 	function verify(&$Model) {
 		extract($this->settings[$Model->alias]);
diff --git a/cake/libs/model/model.php b/cake/libs/model/model.php
index b5f36d9da02..bdecc9f5afe 100644
--- a/cake/libs/model/model.php
+++ b/cake/libs/model/model.php
@@ -41,7 +41,7 @@
  *
  * @package       cake
  * @subpackage    cake.cake.libs.model
- * @link          http://book.cakephp.org/view/66/Models
+ * @link          http://book.cakephp.org/view/1000/Models
  */
 class Model extends Overloadable {