aboutsummaryrefslogtreecommitdiffstats
path: root/src/ng/directive/script.js
diff options
context:
space:
mode:
authorGias Kay Lee2014-01-08 08:10:50 +0800
committerIgor Minar2014-01-08 00:49:29 -0800
commit1c045f1b463cf8c2d0c470fc6e44170997e85d89 (patch)
tree0df8c0d4a00f95237e31fcc769f283f57ee207e0 /src/ng/directive/script.js
parent95e1b2d6121b4e26cf87dcf6746a7b8cb4c25e7f (diff)
downloadangular.js-1c045f1b463cf8c2d0c470fc6e44170997e85d89.tar.bz2
docs(script): add more detailed information
Closes #5671 Closes #5676
Diffstat (limited to 'src/ng/directive/script.js')
-rw-r--r--src/ng/directive/script.js10
1 files changed, 7 insertions, 3 deletions
diff --git a/src/ng/directive/script.js b/src/ng/directive/script.js
index db94a6c7..86233ff8 100644
--- a/src/ng/directive/script.js
+++ b/src/ng/directive/script.js
@@ -6,10 +6,14 @@
* @restrict E
*
* @description
- * Load content of a script tag, with type `text/ng-template`, into `$templateCache`, so that the
- * template can be used by `ngInclude`, `ngView` or directive templates.
+ * Load the content of a `<script>` element into {@link api/ng.$templateCache `$templateCache`}, so that the
+ * template can be used by {@link api/ng.directive:ngInclude `ngInclude`},
+ * {@link api/ngRoute.directive:ngView `ngView`}, or {@link guide/directive directives}. The type of the
+ * `<script>` element must be specified as `text/ng-template`, and a cache name for the template must be
+ * assigned through the element's `id`, which can then be used as a directive's `templateUrl`.
*
- * @param {'text/ng-template'} type must be set to `'text/ng-template'`
+ * @param {'text/ng-template'} type Must be set to `'text/ng-template'`.
+ * @param {string} id Cache name of the template.
*
* @example
<doc:example>