adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2025-01-31 09:06:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updating doc strings in Javascript helper for better api generation.

Browse source 
git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@8047 3807eeeb-6ff5-0310-8944-8be069107fe0
This commit is contained in:
mark_story 2009-02-18 18:26:22 +00:00
parent 96e84c2e60
commit 42ef8bfbcf
1 changed files with 12 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
cake/libs/view/helpers/javascript.php
View file

@ -151,16 +151,18 @@ class JavascriptHelper extends AppHelper {
} }
/** /**
* Returns a JavaScript script tag. * 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 string $script The JavaScript to be wrapped in SCRIPT tags.
* @param array $options Set of options: * @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, * @return string The full SCRIPT element, with the JavaScript inside it, or null,
* if 'inline' is set to false. * 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 * 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. * be relative to your JavaScript path, usually webroot/js.
* *
* @param mixed $url String URL to JavaScript file, or an array of URLs. * @param mixed $url String URL to JavaScript file, or an array of URLs.
* @param boolean $inline If true, the <script /> tag will be printed inline, * @param boolean $inline If true, the <script /> tag will be printed inline,
* otherwise it will be printed in the <head />, using $scripts_for_layout * otherwise it will be printed in the <head />, using $scripts_for_layout
* @see JS_URL * @see JS_URL
* @return string * @return string
*/ */