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
This commit is contained in:
mark_story 2009-02-18 18:26:22 +00:00
parent 96e84c2e60
commit 42ef8bfbcf

View file

@ -152,8 +152,8 @@ class JavascriptHelper extends AppHelper {
/**
* Returns a JavaScript script tag.
*
* @param string $script The JavaScript to be wrapped in SCRIPT tags.
* @param array $options Set of options:
* 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
@ -161,6 +161,8 @@ class JavascriptHelper extends AppHelper {
* - 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:
* @return string The full SCRIPT element, with the JavaScript inside it, or null,
* if 'inline' is set to false.
*/