From 42ef8bfbcf48eb82dd532178219e0f61722faa2d Mon Sep 17 00:00:00 2001 From: mark_story Date: Wed, 18 Feb 2009 18:26:22 +0000 Subject: [PATCH] Updating doc strings in Javascript helper for better api generation. git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@8047 3807eeeb-6ff5-0310-8944-8be069107fe0 --- cake/libs/view/helpers/javascript.php | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/cake/libs/view/helpers/javascript.php b/cake/libs/view/helpers/javascript.php index a316ad227..02d8a507f 100644 --- a/cake/libs/view/helpers/javascript.php +++ b/cake/libs/view/helpers/javascript.php @@ -151,16 +151,18 @@ class JavascriptHelper extends AppHelper { } /** * Returns a JavaScript script tag. + * + * Options: + * + * - allowCache: boolean, designates whether this block is cacheable using the + * current cache settings. + * - safe: boolean, whether this block should be wrapped in CDATA tags. Defaults + * to helper's object configuration. + * - inline: whether the block should be printed inline, or written + * to cached for later output (i.e. $scripts_for_layout). * * @param string $script The JavaScript to be wrapped in SCRIPT tags. * @param array $options Set of options: - * - allowCache: boolean, designates whether this block is cacheable using the - * current cache settings. - * - safe: boolean, whether this block should be wrapped in CDATA tags. Defaults - * to helper's object configuration. - * - inline: whether the block should be printed inline, or written - * to cached for later output (i.e. $scripts_for_layout). - * * @return string The full SCRIPT element, with the JavaScript inside it, or null, * if 'inline' is set to false. */ @@ -241,9 +243,9 @@ class JavascriptHelper extends AppHelper { * the path will be relative to the base path of your application. Otherwise, the path will * be relative to your JavaScript path, usually webroot/js. * - * @param mixed $url String URL to JavaScript file, or an array of URLs. - * @param boolean $inline If true, the