@angular-wave/angular.ts 0.1.1 → 0.1.2

package/src/directive/form/form.js

@@ -36,9 +36,6 @@ function nullFormRenameControl(control, name) {
 }
 
 /**
- * @ngdoc type
- * @name form.FormController
- *
  * @property {boolean} $pristine True if user has not interacted with the form yet.
  * @property {boolean} $dirty True if user has already interacted with the form.
  * @property {boolean} $valid True if all of the containing forms and controls are valid.
@@ -121,10 +118,6 @@ export function FormController(
 
 FormController.prototype = {
   /**
-   * @ngdoc method
-   * @name form.FormController#$rollbackViewValue
-   *
-   * @description
    * Rollback all form controls pending updates to the `$modelValue`.
    *
    * Updates may be pending by a debounced event or because the input is waiting for a some future
@@ -138,10 +131,6 @@ FormController.prototype = {
   },
 
   /**
-   * @ngdoc method
-   * @name form.FormController#$commitViewValue
-   *
-   * @description
    * Commit all form controls pending updates to the `$modelValue`.
    *
    * Updates may be pending by a debounced event or because the input is waiting for a some future
@@ -253,10 +242,6 @@ FormController.prototype = {
   },
 
   /**
-   * @ngdoc method
-   * @name form.FormController#$setDirty
-   *
-   * @description
    * Sets the form to a dirty state.
    *
    * This method can be called to add the 'ng-dirty' class and set the form to a dirty
@@ -271,10 +256,6 @@ FormController.prototype = {
   },
 
   /**
-   * @ngdoc method
-   * @name form.FormController#$setPristine
-   *
-   * @description
    * Sets the form to its pristine state.
    *
    * This method sets the form's `$pristine` state to true, the `$dirty` state to false, removes
@@ -301,10 +282,6 @@ FormController.prototype = {
   },
 
   /**
-   * @ngdoc method
-   * @name form.FormController#$setUntouched
-   *
-   * @description
    * Sets the form to its untouched state.
    *
    * This method can be called to remove the 'ng-touched' class and set the form controls to their
@@ -320,10 +297,6 @@ FormController.prototype = {
   },
 
   /**
-   * @ngdoc method
-   * @name form.FormController#$setSubmitted
-   *
-   * @description
    * Sets the form to its `$submitted` state. This will also set `$submitted` on all child and
    * parent forms of the form.
    */
@@ -348,10 +321,6 @@ FormController.prototype = {
 };
 
 /**
- * @ngdoc method
- * @name form.FormController#$setValidity
- *
- * @description
  * Change the validity state of the form, and notify the parent form (if any).
  *
  * Application developers will rarely need to call this method directly. It is used internally, by
@@ -397,11 +366,6 @@ addSetValidityMethod({
 });
 
 /**
- * @ngdoc directive
- * @name ngForm
- * @restrict EA
- *
- * @description
  * Helper directive that makes it possible to create control groups inside a
  * {@link ng.directive:form `form`} directive.
  * These "child forms" can be used, for example, to determine the validity of a sub-group of
@@ -421,11 +385,6 @@ addSetValidityMethod({
  */
 
 /**
- * @ngdoc directive
- * @name form
- * @restrict E
- *
- * @description
  * Directive that instantiates
  * {@link form.FormController FormController}.
  *

package/src/directive/model/model.js

@@ -300,10 +300,6 @@ export class NgModelController {
   }
 
   /**
-   * @ngdoc method
-   * @name ngModel.NgModelController#$render
-   *
-   * @description
    * Called when the view needs to be updated. It is expected that the user of the ng-model
    * directive will implement this method.
    *
@@ -322,10 +318,6 @@ export class NgModelController {
   $render() {}
 
   /**
-   * @ngdoc method
-   * @name ngModel.NgModelController#$isEmpty
-   *
-   * @description
    * This is called when we need to determine if the value of an input is empty.
    *
    * For instance, the required directive does this to work out if the input has data or not.
@@ -366,10 +358,6 @@ export class NgModelController {
   }
 
   /**
-   * @ngdoc method
-   * @name ngModel.NgModelController#$setPristine
-   *
-   * @description
    * Sets the control to its pristine state.
    *
    * This method can be called to remove the `ng-dirty` class and set the control to its pristine
@@ -389,10 +377,6 @@ export class NgModelController {
   }
 
   /**
-   * @ngdoc method
-   * @name ngModel.NgModelController#$setDirty
-   *
-   * @description
    * Sets the control to its dirty state.
    *
    * This method can be called to remove the `ng-pristine` class and set the control to its dirty
@@ -413,10 +397,6 @@ export class NgModelController {
   }
 
   /**
-   * @ngdoc method
-   * @name ngModel.NgModelController#$setUntouched
-   *
-   * @description
    * Sets the control to its untouched state.
    *
    * This method can be called to remove the `ng-touched` class and set the control to its
@@ -436,10 +416,6 @@ export class NgModelController {
   }
 
   /**
-   * @ngdoc method
-   * @name ngModel.NgModelController#$setTouched
-   *
-   * @description
    * Sets the control to its touched state.
    *
    * This method can be called to remove the `ng-untouched` class and set the control to its
@@ -458,10 +434,6 @@ export class NgModelController {
   }
 
   /**
-   * @ngdoc method
-   * @name ngModel.NgModelController#$rollbackViewValue
-   *
-   * @description
    * Cancel an update and reset the input element's value to prevent an update to the `$modelValue`,
    * which may be caused by a pending debounced event or because the input is waiting for some
    * future event.
@@ -553,10 +525,6 @@ export class NgModelController {
   }
 
   /**
-   * @ngdoc method
-   * @name ngModel.NgModelController#$validate
-   *
-   * @description
    * Runs each of the registered validators (first synchronous validators and then
    * asynchronous validators).
    * If the validity changes to invalid, the model will be set to `undefined`,

package/src/directive/ref/ref.js

@@ -1,11 +1,6 @@
 import { getNodeName, minErr, directiveNormalize } from "../../shared/utils";
 
 /**
- * @ngdoc directive
- * @name ngRef
- * @restrict A
- *
- * @description
  * The `ngRef` attribute tells AngularJS to assign the controller of a component (or a directive)
  * to the given property in the current scope. It is also possible to add the jqlite-wrapped DOM
  * element to the scope.

package/src/directive/script/script.js

@@ -1,18 +1,3 @@
-/**
- * @ngdoc directive
- * @name script
- * @restrict E
- *
- * @description
- * Load the content of a `<script>` element into {@link ng.$templateCache `$templateCache`}, so that the
- * template can be used by {@link ng.directive:ngInclude `ngInclude`},
- * {@link 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 {string} type Must be set to `'text/ng-template'`.
- * @param {string} id Cache name of the template.
- */
 export const scriptDirective = [
   "$templateCache",
   ($templateCache) => ({

package/src/directive/script/script.md

@@ -0,0 +1,11 @@
+/\*\*
+
+- Load the content of a `<script>` element into {@link ng.$templateCache `$templateCache`}, so that the
+- template can be used by {@link ng.directive:ngInclude `ngInclude`},
+- {@link 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 {string} type Must be set to `'text/ng-template'`.
+- @param {string} id Cache name of the template.
+  \*/

package/src/directive/select/select.js

@@ -179,10 +179,6 @@ function SelectController($element, $scope) {
   };
 
   /**
-   * @ngdoc method
-   * @name select.SelectController#$hasEmptyOption
-   *
-   * @description
    *
    * Returns `true` if the select element currently has an empty option
    * element, i.e. an option that signifies that the select is empty / the selection is null.
@@ -193,10 +189,6 @@ function SelectController($element, $scope) {
   };
 
   /**
-   * @ngdoc method
-   * @name select.SelectController#$isUnknownOptionSelected
-   *
-   * @description
    *
    * Returns `true` if the select element's unknown option is selected. The unknown option is added
    * and automatically selected whenever the select model doesn't match any option.
@@ -208,11 +200,6 @@ function SelectController($element, $scope) {
   };
 
   /**
-   * @ngdoc method
-   * @name select.SelectController#$isEmptyOptionSelected
-   *
-   * @description
-   *
    * Returns `true` if the select element has an empty option and this empty option is currently
    * selected. Returns `false` if the select element has no empty option or it is not selected.
    *

package/src/directive/transclude/transclude.js

@@ -2,11 +2,6 @@ import { minErr } from "../../shared/utils";
 import { startingTag } from "../../shared/jqlite/jqlite";
 
 /**
- * @ngdoc directive
- * @name ngTransclude
- * @restrict EA
- *
- * @description
  * Directive that marks the insertion point for the transcluded DOM of the nearest parent directive that uses transclusion.
  *
  * You can specify that you want to insert a named transclusion slot, instead of the default slot, by providing the slot name

package/src/directive/validators/validators.js

@@ -9,15 +9,11 @@ import { REGEX_STRING_REGEXP } from "./../attrs/attrs";
 import { startingTag } from "../../shared/jqlite/jqlite";
 
 /**
- * @ngdoc directive
- * @name ngRequiredf
- * @restrict A
  *
  * @param {String} ngRequired AngularJS expression. If it evaluates to `true`, it sets the
  *                                `required` attribute to the element and adds the `required`
  *                                {@link ngModel.NgModelController#$validators `validator`}.
  *
- * @description
  *
  * ngRequired adds the required {@link ngModel.NgModelController#$validators `validator`} to {@link ngModel `ngModel`}.
  * It is most often used for {@link input `input`} and {@link select `select`} controls, but can also be
@@ -68,10 +64,6 @@ export const requiredDirective = [
 ];
 
 /**
- * @ngdoc directive
- * @name ngPattern
- * @restrict A
- *
  * @param {String|RegExp} ngPattern AngularJS expression that must evaluate to a `RegExp` or a `String`
  *                                      parsable into a `RegExp`, or a `RegExp` literal. See above for
  *                                      more details.
@@ -178,10 +170,6 @@ export const patternDirective = [
 ];
 
 /**
- * @ngdoc directive
- * @name ngMaxlength
- * @restrict A
- *
  * @param {String} ngMaxlength AngularJS expression that must evaluate to a `Number` or `String`
  *                                 parsable into a `Number`. Used as value for the `maxlength`
  *                                 {@link ngModel.NgModelController#$validators validator}.
@@ -241,9 +229,6 @@ export const maxlengthDirective = [
 ];
 
 /**
- * @ngdoc directive
- * @name ngMinlength
- * @restrict A
  *
  * @param {string} ngMinlength AngularJS expression that must evaluate to a `Number` or `String`
  *                                 parsable into a `Number`. Used as value for the `minlength`

package/src/router/directives/view-directive.js

@@ -249,12 +249,6 @@ export let ngView = [
               $$animLeave: animLeave,
             };
             /**
-             * @ngdoc event
-             * @name ui.router.state.directive:ui-view#$viewContentLoading
-             * @eventOf ui.router.state.directive:ui-view
-             * @eventType emits on ui-view directive scope
-             * @description
-             *
              * Fired once the view **begins loading**, *before* the DOM is rendered.
              *
              * @param {Object} event Event object.
@@ -280,11 +274,6 @@ export let ngView = [
             currentEl = cloned;
             currentScope = newScope;
             /**
-             * @ngdoc event
-             * @name ui.router.state.directive:ui-view#$viewContentLoaded
-             * @eventOf ui.router.state.directive:ui-view
-             * @eventType emits on ui-view directive scope
-             * @description           *
              * Fired once the view is **loaded**, *after* the DOM is rendered.
              *
              * @param {Object} event Event object.

package/src/services/browser.js

@@ -164,9 +164,6 @@ export function Browser(taskTracker) {
   }
 
   /**
-   * @name $browser#onUrlChange
-   *
-   * @description
    * Register callback function that will be called, when url changes.
    *
    * It's only called when the url is changed from outside of AngularJS:
@@ -224,9 +221,6 @@ export function Browser(taskTracker) {
   /// ///////////////////////////////////////////////////////////
 
   /**
-   * @name $browser#baseHref
-   *
-   * @description
    * Returns current <base href>
    * (always relative - without domain)
    *
@@ -238,13 +232,11 @@ export function Browser(taskTracker) {
   };
 
   /**
-   * @name $browser#defer
    * @param {function():any} fn A function, who's execution should be deferred.
    * @param {number=} [delay=0] Number of milliseconds to defer the function execution.
    * @param {string=} [taskType=DEFAULT_TASK_TYPE] The type of task that is deferred.
    * @returns {number} DeferId that can be used to cancel the task via `$browser.cancel()`.
    *
-   * @description
    * Executes a fn asynchronously via `setTimeout(fn, delay)`.
    *
    * Unlike when calling `setTimeout` directly, in test this function is mocked and instead of using

package/src/services/cache-factory.js

@@ -38,10 +38,6 @@ export function CacheFactoryProvider() {
       let staleEnd = null;
 
       /**
-       * @ngdoc type
-       * @name $cacheFactory.Cache
-       *
-       * @description
        * A cache object used to store and retrieve data, primarily used by
        * {@link $templateRequest $templateRequest} and the {@link ng.directive:script script}
        * directive to cache templates and other data.
@@ -78,11 +74,6 @@ export function CacheFactoryProvider() {
        */
       return (caches[cacheId] = {
         /**
-         * @ngdoc method
-         * @name $cacheFactory.Cache#put
-         * @kind function
-         *
-         * @description
          * Inserts a named entry into the {@link $cacheFactory.Cache Cache} object to be
          * retrieved later, and incrementing the size of the cache if the key was not already
          * present in the cache. If behaving like an LRU cache, it will also remove stale
@@ -114,11 +105,6 @@ export function CacheFactoryProvider() {
         },
 
         /**
-         * @ngdoc method
-         * @name $cacheFactory.Cache#get
-         * @kind function
-         *
-         * @description
          * Retrieves named data stored in the {@link $cacheFactory.Cache Cache} object.
          *
          * @param {string} key the key of the data to be retrieved
@@ -137,11 +123,6 @@ export function CacheFactoryProvider() {
         },
 
         /**
-         * @ngdoc method
-         * @name $cacheFactory.Cache#remove
-         * @kind function
-         *
-         * @description
          * Removes an entry from the {@link $cacheFactory.Cache Cache} object.
          *
          * @param {string} key the key of the entry to be removed
@@ -166,11 +147,6 @@ export function CacheFactoryProvider() {
         },
 
         /**
-         * @ngdoc method
-         * @name $cacheFactory.Cache#removeAll
-         * @kind function
-         *
-         * @description
          * Clears the cache object of any entries.
          */
         removeAll() {
@@ -181,11 +157,6 @@ export function CacheFactoryProvider() {
         },
 
         /**
-         * @ngdoc method
-         * @name $cacheFactory.Cache#destroy
-         * @kind function
-         *
-         * @description
          * Destroys the {@link $cacheFactory.Cache Cache} object entirely,
          * removing it from the {@link $cacheFactory $cacheFactory} set.
          */
@@ -197,11 +168,6 @@ export function CacheFactoryProvider() {
         },
 
         /**
-         * @ngdoc method
-         * @name $cacheFactory.Cache#info
-         * @kind function
-         *
-         * @description
          * Retrieve information regarding a particular {@link $cacheFactory.Cache Cache}.
          *
          * @returns {object} an object with the following properties:
@@ -247,10 +213,6 @@ export function CacheFactoryProvider() {
     }
 
     /**
-     * @ngdoc method
-     * @name $cacheFactory#info
-     *
-     * @description
      * Get information about all the caches that have been created
      *
      * @returns {Object} - key-value map of `cacheId` to the result of calling `cache#info`
@@ -264,10 +226,6 @@ export function CacheFactoryProvider() {
     };
 
     /**
-     * @ngdoc method
-     * @name $cacheFactory#get
-     *
-     * @description
      * Get access to a cache object by the `cacheId` used when it was created.
      *
      * @param {string} cacheId Name or id of a cache to access.

package/src/services/http/http.js

@@ -290,11 +290,6 @@ function isSuccess(status) {
 }
 
 /**
- * @ngdoc provider
- * @name $httpProvider
- *
- *
- * @description
  * Use `$httpProvider` to change the default behavior of the {@link ng.$http $http} service.
  */
 export function $HttpProvider() {
@@ -374,10 +369,6 @@ export function $HttpProvider() {
 
   let useApplyAsync = false;
   /**
-   * @ngdoc method
-   * @name $httpProvider#useApplyAsync
-   * @description
-   *
    * Configure $http service to combine processing of multiple http responses received at around
    * the same time via {@link ng.$rootScope.Scope#$applyAsync $rootScope.$applyAsync}. This can result in
    * significant performance improvement for bigger applications that make many HTTP requests
@@ -770,10 +761,6 @@ export function $HttpProvider() {
        */
 
       /**
-       * @ngdoc method
-       * @name $http#patch
-       *
-       * @description
        * Shortcut method to perform `PATCH` request.
        *
        * @param {string} url Relative or absolute URL specifying the destination of the request
@@ -785,10 +772,6 @@ export function $HttpProvider() {
       createShortMethodsWithData("post", "put", "patch");
 
       /**
-       * @ngdoc property
-       * @name $http#defaults
-       *
-       * @description
        * Runtime equivalent of the `$httpProvider.defaults` property. Allows configuration of
        * default headers, withCredentials as well as request and response transformations.
        *

package/src/services/http-backend/http-backend.js

@@ -7,10 +7,6 @@ import {
 } from "../../shared/utils";
 
 /**
-
- *
- *
- * @description
  * HTTP backend used by the {@link ng.$http service} that delegates to
  * XMLHttpRequest object and deals with browser incompatibilities.
  *

package/src/services/log.js

@@ -11,7 +11,7 @@ import { isError } from "../shared/utils";
  */
 
 /**
- * @typedef {Object} angular.LogService
+ * @typedef {Object} LogService
  * @property {LogCall} debug - Log a debug messages
  * @property {LogCall} error - Log a error message
  * @property {LogCall} info - Log a info message
@@ -20,7 +20,7 @@ import { isError } from "../shared/utils";
  */
 
 /**
- * @type {angular.LogService}
+ * @type {LogService}
  */
 export let LogService = {
   debug: undefined,
@@ -31,16 +31,13 @@ export let LogService = {
 };
 
 /**
- * @typedef {import('../types').ServiceProvider} angular.LogProvider
+ * @typedef {import('../types').ServiceProvider} LogProvider
  * @property {function(): boolean} debugEnabled - Function to get the current debug state.
  * @property {function(boolean): angular.LogProvider} debugEnabled - Function to enable or disable debug.
  */
 
 /**
- * @name $logProvider
- * @type {angular.LogProvider}
- *
- * @description
+ * @type {LogProvider}
  * Use the `$logProvider` to configure how the application logs messages
  */
 export class $LogProvider {
@@ -49,8 +46,6 @@ export class $LogProvider {
   }
 
   /**
-   * @name $logProvider#debugEnabled
-   * @description
    * @param {boolean=} flag enable or disable debug level messages
    * @returns {*} current value if used as getter or itself (chaining) if used as setter
    */

package/src/types.js

@@ -52,25 +52,21 @@
  */
 
 /**
- * @typedef {Object} OnChangesObject
- * @description Object representing changes in one-way bound properties.
+ * @typedef {Object} OnChangesObject Object representing changes in one-way bound properties.
  * Keys are the names of the bound properties that have changed, and values are instances of IChangesObject.
- * @property {ChangesObject<any>} property - Represents a changed property.
+ * @property {ChangesObject} property - Represents a changed property.
  */
 
 /**
- * @typedef {Object} ChangesObject
- * @description Object representing changes in a property.
+ * @typedef {Object} ChangesObject Object representing changes in a property.
  * @property {*} currentValue - Current value of the property.
  * @property {*} previousValue - Previous value of the property.
  * @property {function(): boolean} isFirstChange - Function to check if it's the first change of the property.
  */
 
 /**
- * @typedef {Object} Controller
- * @property {string} name
- * @description Interface representing the lifecycle hooks for AngularJS directive controllers.
- *
+ * @typedef {Object} Controller  Interface representing the lifecycle hooks for AngularJS directive controllers.
+ * @property {string} name *
  * @property {function(): void} [$onInit]
  * Called on each controller after all the controllers on an element have been constructed and had their bindings
  * initialized (and before the pre & post linking functions for the directives on this element). This is a good
@@ -102,9 +98,6 @@
  * analogous to the ngAfterViewInit and ngAfterContentInit hooks in Angular 2. Since the compilation process is rather
  * different in Angular 1 there is no direct mapping and care should be taken when upgrading.
  *
- * @property {*} [s: string]
- * IController implementations frequently do not implement any of its methods.
- * A string indexer indicates to TypeScript not to issue a weak type error in this case.
  */
 
 /**
@@ -319,8 +312,7 @@
 
 /**
  *
- * @typedef {Object} Module
- * @description AngularJS module interface for registering components, services, providers, etc.
+ * @typedef {Object} Module AngularJS module interface for registering components, services, providers, etc.
  * @property {function(string, ComponentOptions): Module} component
  *   Use this method to register a component.
  * @property {function({ [componentName: string]: ComponentOptions }): Module} component
@@ -329,13 +321,13 @@
  *   Use this method to register work which needs to be performed on module loading.
  * @property {function(any[]): Module} config
  *   Use this method to register work which needs to be performed on module loading.
- * @property {function<T>(string, T): Module} constant
+ * @property {function(string, any): Module} constant
  *   Register a constant service with the $injector.
  * @property {function(Object): Module} constant
  *   Register multiple constant services.
  * @property {function(string, Injectable<ControllerConstructor>): Module} controller
  *   Register a controller with the $controller service.
- * @property {function({ [name: string]: Injectable<ControllerConstructor>> }): Module} controller
+ * @property {function({ [name: string]: Injectable<ControllerConstructor> }): Module} controller
  *   Register multiple controllers.
  * @property {function(string, Injectable<DirectiveFactory>): Module} directive
  *   Register a directive with the compiler.
@@ -361,7 +353,7 @@
  *   Register a service constructor.
  * @property {function(Object.<string, Injectable<Function>>): Module} service
  *   Register multiple service constructors.
- * @property {function<T>(string, T): Module} value
+ * @property {function(string, any): Module} value
  *   Register a value service with the $injector.
  * @property {function(Object): Module} value
  *   Register multiple value services.

package/typedoc/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.