docs($templateFactory): adds docs for $templateFactory

Author: 0x-r4bbit

src/templateFactory.js

@@ -1,33 +1,41 @@
 /**
- * Service. Manages loading of templates.
- * @constructor
- * @name $templateFactory
+ * @ngdoc object
+ * @name ui.router.util.$templateFactory
+ *
  * @requires $http
  * @requires $templateCache
  * @requires $injector
+ *
+ * @description
+ * Service. Manages loading of templates.
  */
 $TemplateFactory.$inject = ['$http', '$templateCache', '$injector'];
 function $TemplateFactory(  $http,   $templateCache,   $injector) {
 
   /**
+   * @ngdoc function
+   * @name ui.router.util.$templateFactory#fromConfig
+   * @methodOf ui.router.util.$templateFactory
+   *
+   * @description
    * Creates a template from a configuration object. 
-   * @function
-   * @name $templateFactory#fromConfig
-   * @methodOf $templateFactory
-   * @param {Object} config  Configuration object for which to load a template. The following
-   *    properties are search in the specified order, and the first one that is defined is
-   *    used to create the template:
-   * @param {string|Function} config.template  html string template or function to load via
-   *    {@link $templateFactory#fromString fromString}.
-   * @param {string|Function} config.templateUrl  url to load or a function returning the url
-   *    to load via {@link $templateFactory#fromUrl fromUrl}.
-   * @param {Function} config.templateProvider  function to invoke via
-   *    {@link $templateFactory#fromProvider fromProvider}.
-   * @param {Object} params  Parameters to pass to the template function.
-   * @param {Object} [locals] Locals to pass to `invoke` if the template is loaded via a
-   *      `templateProvider`. Defaults to `{ params: params }`.
-   * @return {string|Promise.<string>}  The template html as a string, or a promise for that string,
-   *      or `null` if no template is configured.
+   *
+   * @param {object} config Configuration object for which to load a template. 
+   * The following properties are search in the specified order, and the first one 
+   * that is defined is used to create the template:
+   *
+   * @param {string|object} config.template html string template or function to 
+   * load via {@link ui.router.util.$templateFactory#fromString fromString}.
+   * @param {string|object} config.templateUrl url to load or a function returning 
+   * the url to load via {@link ui.router.util.$templateFactory#fromUrl fromUrl}.
+   * @param {Function} config.templateProvider function to invoke via 
+   * {@link ui.router.util.$templateFactory#fromProvider fromProvider}.
+   * @param {object} params  Parameters to pass to the template function.
+   * @param {object} locals Locals to pass to `invoke` if the template is loaded 
+   * via a `templateProvider`. Defaults to `{ params: params }`.
+   *
+   * @return {string|object}  The template html as a string, or a promise for 
+   * that string,or `null` if no template is configured.
    */
   this.fromConfig = function (config, params, locals) {
     return (
@@ -39,27 +47,37 @@ function $TemplateFactory(  $http,   $templateCache,   $injector) {
   };
 
   /**
+   * @ngdoc function
+   * @name ui.router.util.$templateFactory#fromString
+   * @methodOf ui.router.util.$templateFactory
+   *
+   * @description
    * Creates a template from a string or a function returning a string.
-   * @function
-   * @name $templateFactory#fromString
-   * @methodOf $templateFactory
-   * @param {string|Function} template  html template as a string or function that returns an html
-   *      template as a string.
-   * @param {Object} params  Parameters to pass to the template function.
-   * @return {string|Promise.<string>}  The template html as a string, or a promise for that string.
+   *
+   * @param {string|object} template html template as a string or function that 
+   * returns an html template as a string.
+   * @param {object} params Parameters to pass to the template function.
+   *
+   * @return {string|object} The template html as a string, or a promise for that 
+   * string.
    */
   this.fromString = function (template, params) {
     return isFunction(template) ? template(params) : template;
   };
 
   /**
+   * @ngdoc function
+   * @name ui.router.util.$templateFactory#fromUrl
+   * @methodOf ui.router.util.$templateFactory
+   * 
+   * @description
    * Loads a template from the a URL via `$http` and `$templateCache`.
-   * @function
-   * @name $templateFactory#fromUrl
-   * @methodOf $templateFactory
-   * @param {string|Function} url  url of the template to load, or a function that returns a url.
-   * @param {Object} params  Parameters to pass to the url function.
-   * @return {string|Promise.<string>}  The template html as a string, or a promise for that string.
+   *
+   * @param {string|Function} url url of the template to load, or a function 
+   * that returns a url.
+   * @param {Object} params Parameters to pass to the url function.
+   * @return {string|Promise.<string>} The template html as a string, or a promise 
+   * for that string.
    */
   this.fromUrl = function (url, params) {
     if (isFunction(url)) url = url(params);
@@ -70,14 +88,19 @@ function $TemplateFactory(  $http,   $templateCache,   $injector) {
   };
 
   /**
+   * @ngdoc function
+   * @name ui.router.util.$templateFactory#fromUrl
+   * @methodOf ui.router.util.$templateFactory
+   *
+   * @description
    * Creates a template by invoking an injectable provider function.
-   * @function
-   * @name $templateFactory#fromUrl
-   * @methodOf $templateFactory
+   *
    * @param {Function} provider Function to invoke via `$injector.invoke`
    * @param {Object} params Parameters for the template.
-   * @param {Object} [locals] Locals to pass to `invoke`. Defaults to `{ params: params }`.
-   * @return {string|Promise.<string>} The template html as a string, or a promise for that string.
+   * @param {Object} locals Locals to pass to `invoke`. Defaults to 
+   * `{ params: params }`.
+   * @return {string|Promise.<string>} The template html as a string, or a promise 
+   * for that string.
    */
   this.fromProvider = function (provider, params, locals) {
     return $injector.invoke(provider, null, locals || { params: params });