Permalink
Browse files

Docblock fixes to help apigen

  • Loading branch information...
1 parent 9cb5cb0 commit f883840f5d4ff31f9ab46492c4f718fe6d4d6726 @ADmad ADmad committed Feb 28, 2013
@@ -13,7 +13,7 @@
* @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package cake
- * @subpackage cake.console.libs.tasks
+ * @subpackage cake.cake.console.libs.tasks
* @since CakePHP(tm) v 1.3
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
@@ -540,7 +540,7 @@ function __associations() {
* Scaffold View.
*
* @package cake
- * @subpackage cake.cake.libs.controller
+ * @subpackage cake.cake.libs.view
*/
if (!class_exists('ThemeView')) {
App::import('View', 'Theme');
@@ -549,7 +549,8 @@ function __associations() {
/**
* ScaffoldView provides specific view file loading features for scaffolded views.
*
- * @package cake.libs.view
+ * @package cake
+ * @subpackage cake.cake.libs.view
*/
class ScaffoldView extends ThemeView {
@@ -27,8 +27,8 @@
/**
* A class to parse and use the MagicDb for file type analysis
*
- * @package cake.tests
- * @subpackage cake.tests.cases.libs
+ * @package cake
+ * @subpackage cake.cake.libs
*/
class MagicDb extends Object {
@@ -173,10 +173,10 @@ function analyze($file, $options = array()) {
}
/**
- * undocumented class
+ * MagicFileResource
*
- * @package cake.tests
- * @subpackage cake.tests.cases.libs
+ * @package cake
+ * @subpackage cake.cake.libs
*/
class MagicFileResource extends Object{
View
@@ -275,7 +275,7 @@ function connect($route, $defaults = array(), $options = array()) {
}
$defaults += array('plugin' => null);
if (empty($options['action'])) {
- $defaults += array('action' => 'index');
+ $defaults += array('action' => 'index');
}
$routeClass = 'CakeRoute';
if (isset($options['routeClass'])) {
@@ -326,10 +326,10 @@ function connect($route, $defaults = array(), $options = array()) {
* Router::connectNamed(
* array('page' => array('action' => 'index', 'controller' => 'pages')),
* array('default' => false, 'greedy' => false)
- * );
+ * );
* }}}
*
- * @param array $named A list of named parameters. Key value pairs are accepted where values are
+ * @param array $named A list of named parameters. Key value pairs are accepted where values are
* either regex strings to match, or arrays as seen above.
* @param array $options Allows to control all settings: separator, greedy, reset, default
* @return array
@@ -612,7 +612,7 @@ function __connectDefaultRoutes() {
/**
* Takes parameter and path information back from the Dispatcher, sets these
- * parameters as the current request parameters that are merged with url arrays
+ * parameters as the current request parameters that are merged with url arrays
* created later in the request.
*
* @param array $params Parameters and path information
@@ -692,7 +692,7 @@ function getPaths($current = false) {
}
/**
- * Reloads default Router settings. Resets all class variables and
+ * Reloads default Router settings. Resets all class variables and
* removes all connected routes.
*
* @access public
@@ -741,7 +741,7 @@ function promote($which = null) {
* - A combination of controller/action - the method will find url for it.
*
* There are a few 'special' parameters that can change the final URL string that is generated
- *
+ *
* - `base` - Set to false to remove the base path from the generated url. If your application
* is not in the root directory, this can be used to generate urls that are 'cake relative'.
* cake relative urls are required when using requestAction.
@@ -1247,7 +1247,8 @@ function getArgs($args, $options = array()) {
* Not normally created as a standalone. Use Router::connect() to create
* Routes for your application.
*
- * @package cake.libs
+ * @package cake
+ * @subpackage cake.cake.libs
* @since 1.3.0
* @see Router::connect()
*/
@@ -1462,8 +1463,8 @@ function parse($url) {
}
/**
- * Apply persistent parameters to a url array. Persistant parameters are a special
- * key used during route creation to force route parameters to persist when omitted from
+ * Apply persistent parameters to a url array. Persistant parameters are a special
+ * key used during route creation to force route parameters to persist when omitted from
* a url array.
*
* @param array $url The array to apply persistent parameters to.
@@ -1617,12 +1618,13 @@ function _writeUrl($params) {
* Plugin short route, that copies the plugin param to the controller parameters
* It is used for supporting /:plugin routes.
*
- * @package cake.libs
+ * @package cake
+ * @subpackage cake.cake.libs
*/
class PluginShortRoute extends CakeRoute {
/**
- * Parses a string url into an array. If a plugin key is found, it will be copied to the
+ * Parses a string url into an array. If a plugin key is found, it will be copied to the
* controller parameter
*
* @param string $url The url to parse
@@ -19,11 +19,17 @@
* @copyright Copyright 2005-2012, Cake Software Foundation, Inc.
* @link http://cakephp.org CakePHP Project
* @package cake
- * @subpackage cake.view.helpers
+ * @subpackage cake.cake.libs.view.helpers
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
App::import('Helper', 'Js');
+/**
+ * jQuery Engine Helper for JsHelper
+ *
+ * @package cake
+ * @subpackage cake.cake.libs.view.helpers
+ */
class JqueryEngineHelper extends JsBaseEngineHelper {
/**
* Option mappings for jQuery
@@ -178,7 +184,7 @@ function event($type, $callback, $options = array()) {
}
/**
- * Create a domReady event. For jQuery. This method does not
+ * Create a domReady event. For jQuery. This method does not
* bind a 'traditional event' as `$(document).bind('ready', fn)`
* Works in an entirely different fashion than `$(document).ready()`
* The first will not run the function when eval()'d as part of a response
@@ -205,7 +205,7 @@ function value($val, $quoteString = true) {
function writeBuffer($options = array()) {
$domReady = isset($this->params['isAjax']) ? !$this->params['isAjax'] : true;
$defaults = array(
- 'onDomReady' => $domReady, 'inline' => true,
+ 'onDomReady' => $domReady, 'inline' => true,
'cache' => false, 'clear' => true, 'safe' => true
);
$options = array_merge($defaults, $options);
@@ -240,7 +240,7 @@ function writeBuffer($options = array()) {
* Write a script to the buffered scripts.
*
* @param string $script Script string to add to the buffer.
- * @param boolean $top If true the script will be added to the top of the
+ * @param boolean $top If true the script will be added to the top of the
* buffered scripts array. If false the bottom.
* @return void
* @access public
@@ -366,7 +366,7 @@ function set($one, $two = null) {
* and require an iframe or flash.
*
* ### Options
- *
+ *
* - `url` The url you wish the XHR request to submit to.
* - `confirm` A string to use for a confirm() message prior to submitting the request.
* - `method` The method you wish the form to send by, defaults to POST
@@ -429,7 +429,7 @@ function submit($caption = null, $options = array()) {
*/
function _getHtmlOptions($options, $additional = array()) {
$htmlKeys = array_merge(
- array('class', 'id', 'escape', 'onblur', 'onfocus', 'rel', 'title', 'style'),
+ array('class', 'id', 'escape', 'onblur', 'onfocus', 'rel', 'title', 'style'),
$additional
);
$htmlOptions = array();
@@ -452,7 +452,8 @@ function _getHtmlOptions($options, $additional = array()) {
*
* Abstract Base Class for All JsEngines to extend. Provides generic methods.
*
- * @package cake.view.helpers
+ * @package cake
+ * @subpackage cake.cake.libs.view.helpers
*/
class JsBaseEngineHelper extends AppHelper {
/**
@@ -21,12 +21,18 @@
* @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package cake
- * @subpackage cake.libs.view.helpers
+ * @subpackage cake.cake.libs.view.helpers
* @since CakePHP(tm) v 1.3
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
App::import('Helper', 'Js');
+/**
+ * Mootools Engine Helper for JsHelper
+ *
+ * @package cake
+ * @subpackage cake.cake.libs.view.helpers
+ */
class MootoolsEngineHelper extends JsBaseEngineHelper {
/**
* Option mappings for MooTools
@@ -16,12 +16,18 @@
* @copyright Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package cake
- * @subpackage cake.libs.view.helpers
+ * @subpackage cake.cake.libs.view.helpers
* @since CakePHP(tm) v 1.3
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
App::import('Helper', 'Js');
+/**
+ * Prototype Engine Helper for JsHelper
+ *
+ * @package cake
+ * @subpackage cake.cake.libs.view.helpers
+ */
class PrototypeEngineHelper extends JsBaseEngineHelper {
/**
* Is the current selection a multiple selection? or is it just a single element.

0 comments on commit f883840

Please sign in to comment.