diff options
| -rw-r--r-- | src/ng/directive/script.js | 10 |
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> |
