docs(*): categorize new files into modules

Author: christopherthielen

Gruntfile.js

@@ -180,7 +180,7 @@ module.exports = function (grunt) {
 
   grunt.registerTask('docs', 'Generate documentation to _doc', function() { 
     promising(this, 
-      system('./node_modules/typedoc/bin/typedoc --readme ./README.md --name "UI-Router" --theme ./typedoctheme --mode modules --module commonjs --target es5 --out _doc  src/params src/path src/resolve src/state src/transition src/url src/view src/ng1')
+      system('./node_modules/typedoc/bin/typedoc --experimentalDecorators --readme ./README.md --name "UI-Router" --theme ./typedoctheme --mode modules --module commonjs --target es5 --out _doc  src')
     );
   });
 

src/common/predicates.ts

@@ -1,4 +1,4 @@
-/** Predicates @module common */
+/** Predicates @module common */ /** */
 import {and, not, pipe, prop} from "./hof";
 
 const toStr = Object.prototype.toString;

src/core.ts

@@ -1,5 +1,6 @@
 /// <reference path='../typings/angularjs/angular.d.ts' />
 /// <reference path='../typings/es6-shim/es6-shim.d.ts' />
+/** @module core */ /** */
 
 import * as common from "./common/module";
 import * as params from "./params/module";

src/justjs.ts

@@ -1,3 +1,8 @@
+/**
+ * Naive, pure JS implementation of core ui-router services
+ *
+ * @module justjs
+ */ /** */
 export * from "./core";
 import {services} from "./common/coreservices";
 import {isDefined, isFunction, isArray, isObject, isInjectable} from "./common/predicates";

src/ng1.ts

@@ -2,6 +2,7 @@
 /// <reference path='../typings/es6-shim/es6-shim.d.ts' />
 /**
  * Main entry point for angular 1.x build
+ * @module ng1
  */
 /** for typedoc */
 

src/ng1/services.ts

@@ -3,7 +3,7 @@
  *
  * - Provides an implementation for the [[CoreServices]] API, based on angular 1 services.
  * - Also registers some services with the angular 1 injector.
- * - Creates and bootstraps a new [[Router]] object, usiong the angular 1 lifecycle
+ * - Creates and bootstraps a new [[UIRouter]] object.  Ties it to the the angular 1 lifecycle.
  *
  * @module ng1
  * @preferred
@@ -24,6 +24,7 @@ import {State} from "../state/module";
 import {trace} from "../common/trace";
 import {ng1ViewsBuilder, ng1ViewConfigFactory, Ng1ViewConfig} from "./viewsBuilder";
 
+/** @hidden */
 let app = angular.module("ui.router.angular1", []);
 
 /**

src/ng1/stateEvents.ts

@@ -14,7 +14,7 @@
  * angular.module("myApplication", ['ui.router', 'ui.router.state.events']
  * ```
  *
- * @module ng1_state_events
+ * @module ng1/state_events
  */
 
 /** for typedoc */

src/ng1/viewScroll.ts

@@ -1,4 +1,4 @@
-/** @module view */ /** for typedoc */
+/** @module ng1 */ /** */
 import {IServiceProviderFactory} from "angular";
 
 /**

src/ng2.ts

@@ -1,6 +1,7 @@
 /// <reference path='../typings/es6-shim/es6-shim.d.ts' />
 /**
  * Main entry point for angular 2.x build
+ * @module ng2
  */
 /** for typedoc */
 

src/ng2/uiSref.ts

@@ -1,3 +1,4 @@
+/** @module ng2 */ /** */
 import {UIRouter} from "../router";
 import {Directive} from "angular2/core";
 import {Optional} from "angular2/core";

src/ng2/uiSrefActive.ts

@@ -1,3 +1,4 @@
+/** @module ng2 */ /** */
 import {UIRouter} from "../router";
 import {Directive} from "angular2/core";
 import {UiSref} from "./uiSref";

src/ng2/viewsBuilder.ts

@@ -1,3 +1,4 @@
+/** @module ng2 */ /** */
 import {State} from "../state/stateObject";
 import {pick, forEach} from "../common/common";
 

src/router.ts

@@ -1,3 +1,4 @@
+/** @module common */ /** */
 import {UrlMatcherFactory} from "./url/urlMatcherFactory";
 import {UrlRouterProvider} from "./url/urlRouter";
 import {StateProvider} from "./state/state";

src/state/hooks/resolveHooks.ts

@@ -36,8 +36,8 @@ export class ResolveHooks {
       let node = find(<any[]> treeChanges.entering, propEq('state', $state$));
 
       // A new Resolvable contains all the resolved data in this context as a single object, for injection as `$resolve$`
-      let $resolve$ = new Resolvable("$resolve$", () => map(context.getResolvables(), (r: Resolvable) => r.data));
       let context = node.resolveContext;
+      let $resolve$ = new Resolvable("$resolve$", () => map(context.getResolvables(), (r: Resolvable) => r.data));
       var options = extend({transition: $transition$}, { resolvePolicy: LAZY });
 
       // Resolve all the LAZY resolves, then resolve the `$resolve$` object, then add `$resolve$` to the context

src/state/stateService.ts

@@ -1,3 +1,4 @@
+/** @module state */ /** */
 import {extend, defaults } from "../common/common";
 import {isDefined, isObject, isString} from "../common/predicates";
 import {Queue} from "../common/queue";
@@ -474,7 +475,7 @@ export class StateService {
    */
   get(): StateDeclaration[];
   get(stateOrName: StateOrName, base: StateOrName): StateDeclaration;
-  get(stateOrName?: StateOrName, base?: StateOrName): (StateDeclaration|StateDeclaration[]) {
+  get(stateOrName?: StateOrName, base?: StateOrName): any {
     if (arguments.length === 0) return this.stateRegistry.get();
     return this.stateRegistry.get(stateOrName, base || this.$current);
   }