diff --git a/package.json b/package.json index a4eda1733..c977642d1 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "clean": "shx rm -rf lib lib-esm _bundles _doc", "build": "npm run clean && tsc && tsc -p tsconfig.esm.json && webpack", "test": "karma start config/karma.ng2.js", - "docs": "typedoc --tsconfig tsconfig.typedoc.json --readme README.md --name 'ui-router-ng2' --theme node_modules/ui-router-typedoc-themes/bin/default --out _doc --external-aliases internalapi,external --navigation-label-globals ui-router-ng2" + "docs": "typedoc --tsconfig tsconfig.typedoc.json --readme README.md --name 'ui-router-ng2' --theme node_modules/ui-router-typedoc-themes/bin/default --out _doc --internal-aliases internal,coreapi,ng2api --external-aliases internalapi,external --navigation-label-globals ui-router-ng2" }, "homepage": "https://ui-router.github.io/ng2", "contributors": [ diff --git a/src/ng2.ts b/src/ng2.ts index 8e27183e9..e44188599 100644 --- a/src/ng2.ts +++ b/src/ng2.ts @@ -1,4 +1,4 @@ -/** @module ng2 */ /** for typedoc */ +/** @ng2api @module ng2 */ /** for typedoc */ export * from "ui-router-core"; import "ui-router-core/lib/justjs"; diff --git a/src/ng2/directives/directives.ts b/src/ng2/directives/directives.ts index 954dd9b30..f03c4ac35 100644 --- a/src/ng2/directives/directives.ts +++ b/src/ng2/directives/directives.ts @@ -5,7 +5,9 @@ * - [[UISref]]: A state ref to a target state; navigates when clicked * - [[UISrefActive]]: (and `UISrefActiveEq`) Adds a css class when a UISref's target state (or a child state) is active * - * @preferred @module directives + * @ng2api + * @preferred + * @module directives */ /** */ import {UISref, AnchorUISref} from "./uiSref"; import {UISrefActive} from "./uiSrefActive"; diff --git a/src/ng2/directives/uiSref.ts b/src/ng2/directives/uiSref.ts index c8c6a82aa..2ff5434f4 100644 --- a/src/ng2/directives/uiSref.ts +++ b/src/ng2/directives/uiSref.ts @@ -1,4 +1,4 @@ -/** @module directives */ /** */ +/** @ng2api @module directives */ /** */ import {UIRouter, UIRouterGlobals} from "ui-router-core"; import {Directive, Inject, Input} from "@angular/core"; import {Optional} from "@angular/core"; diff --git a/src/ng2/directives/uiSrefActive.ts b/src/ng2/directives/uiSrefActive.ts index 6a33ade21..f50ed5ee1 100644 --- a/src/ng2/directives/uiSrefActive.ts +++ b/src/ng2/directives/uiSrefActive.ts @@ -1,4 +1,4 @@ -/** @module directives */ /** */ +/** @ng2api @module directives */ /** */ import {Directive, Input, ElementRef, Host, Renderer} from "@angular/core"; import {UISrefStatus, SrefStatus} from "./uiSrefStatus"; import {Subscription} from "rxjs/Subscription"; diff --git a/src/ng2/directives/uiSrefStatus.ts b/src/ng2/directives/uiSrefStatus.ts index f441c42f3..b0568b2a1 100644 --- a/src/ng2/directives/uiSrefStatus.ts +++ b/src/ng2/directives/uiSrefStatus.ts @@ -1,4 +1,4 @@ -/** @module directives */ /** */ +/** @ng2api @module directives */ /** */ import {Directive, Output, EventEmitter, ContentChildren, QueryList, Inject} from "@angular/core"; import {UISref} from "./uiSref"; import {PathNode} from "ui-router-core"; diff --git a/src/ng2/directives/uiView.ts b/src/ng2/directives/uiView.ts index f669bd8c9..77aa887b5 100755 --- a/src/ng2/directives/uiView.ts +++ b/src/ng2/directives/uiView.ts @@ -1,4 +1,4 @@ -/** @module directives */ /** */ +/** @ng2api @module directives */ /** */ import { Component, ComponentFactoryResolver, ViewContainerRef, Input, ComponentRef, Type, ReflectiveInjector, ViewChild, Injector, Inject diff --git a/src/ng2/interface.ts b/src/ng2/interface.ts index 60a0cc27c..7f84eda16 100644 --- a/src/ng2/interface.ts +++ b/src/ng2/interface.ts @@ -1,4 +1,4 @@ -/** @module state */ /** */ +/** @ng2api @module state */ /** */ import {StateDeclaration, _ViewDeclaration} from "ui-router-core"; import {Transition} from "ui-router-core"; import {Type, OpaqueToken} from "@angular/core"; diff --git a/src/ng2/lazyLoadNgModule.ts b/src/ng2/lazyLoadNgModule.ts index 047869e15..3fb53898e 100644 --- a/src/ng2/lazyLoadNgModule.ts +++ b/src/ng2/lazyLoadNgModule.ts @@ -1,4 +1,4 @@ -/** @module core */ /** */ +/** @ng2api @module core */ /** */ import {NgModuleFactoryLoader, NgModuleRef, Injector, NgModuleFactory, Type, Compiler} from "@angular/core"; import {Transition, LazyLoadResult, UIRouter, Resolvable, NATIVE_INJECTOR_TOKEN, isString} from "ui-router-core"; import {RootModule, StatesModule, UIROUTER_ROOT_MODULE, UIROUTER_MODULE_TOKEN} from "./uiRouterNgModule"; diff --git a/src/ng2/uiRouterNgModule.ts b/src/ng2/uiRouterNgModule.ts index 5ac08444c..76da7bffa 100644 --- a/src/ng2/uiRouterNgModule.ts +++ b/src/ng2/uiRouterNgModule.ts @@ -1,4 +1,4 @@ -/** @module core */ /** */ +/** @ng2api @module core */ /** */ import {Ng2StateDeclaration} from "./interface"; import {NgModule, OpaqueToken, ModuleWithProviders, ANALYZE_FOR_ENTRY_COMPONENTS, Provider, Type} from "@angular/core"; import {CommonModule} from "@angular/common"; diff --git a/tsconfig.typedoc.json b/tsconfig.typedoc.json index 00e35ad02..d05a082af 100644 --- a/tsconfig.typedoc.json +++ b/tsconfig.typedoc.json @@ -10,41 +10,8 @@ "sourceMap": false }, "files": [ + "src/ng2.ts", "../ui-router-core/src/index.ts", - "../ui-router-core/src/interface.ts", - "../ui-router-core/src/globals.ts", - "../ui-router-core/src/router.ts", - "../ui-router-core/src/common/glob.ts", - "../ui-router-core/src/common/trace.ts", - "../ui-router-core/src/params/module.ts", - "../ui-router-core/src/params/interface.ts", - "../ui-router-core/src/resolve/interface.ts", - "../ui-router-core/src/resolve/resolvable.ts", - "../ui-router-core/src/state/interface.ts", - "../ui-router-core/src/state/module.ts", - "../ui-router-core/src/state/stateObject.ts", - "../ui-router-core/src/state/stateRegistry.ts", - "../ui-router-core/src/state/stateService.ts", - "../ui-router-core/src/state/targetState.ts", - "../ui-router-core/src/transition/module.ts", - "../ui-router-core/src/transition/interface.ts", - "../ui-router-core/src/transition/transition.ts", - "../ui-router-core/src/transition/transitionService.ts", - "../ui-router-core/src/url/module.ts", - "../ui-router-core/src/url/urlMatcher.ts", - "../ui-router-core/src/url/urlMatcherFactory.ts", - "../ui-router-core/src/url/urlRouter.ts", - "../ui-router-core/src/view/module.ts", - "../ui-router-core/src/view/view.ts", - "src/ng2/directives/directives.ts", - "src/ng2/directives/uiSref.ts", - "src/ng2/directives/uiSrefActive.ts", - "src/ng2/directives/uiSrefStatus.ts", - "src/ng2/directives/uiView.ts", - "src/ng2/lazyLoadNgModule.ts", - "src/ng2/uiRouterNgModule.ts", - "src/ng2/interface.ts", - "src/index.ts", "node_modules/typescript/lib/lib.es6.d.ts" ] }