Skip to content

Commit

Permalink
docs(*): Mark files as @ng2docs. Symbols in these files will appear i…
Browse files Browse the repository at this point in the history
…n the docs by default.
  • Loading branch information
christopherthielen committed Jan 11, 2017
1 parent 7d4ac6d commit 0a997a9
Show file tree
Hide file tree
Showing 11 changed files with 13 additions and 44 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
2 changes: 1 addition & 1 deletion src/ng2.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** @module ng2 */ /** for typedoc */
/** @ng2api @module ng2 */ /** for typedoc */
export * from "ui-router-core";
import "ui-router-core/lib/justjs";

Expand Down
4 changes: 3 additions & 1 deletion src/ng2/directives/directives.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down
2 changes: 1 addition & 1 deletion src/ng2/directives/uiSref.ts
Original file line number Diff line number Diff line change
@@ -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";
Expand Down
2 changes: 1 addition & 1 deletion src/ng2/directives/uiSrefActive.ts
Original file line number Diff line number Diff line change
@@ -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";
Expand Down
2 changes: 1 addition & 1 deletion src/ng2/directives/uiSrefStatus.ts
Original file line number Diff line number Diff line change
@@ -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";
Expand Down
2 changes: 1 addition & 1 deletion src/ng2/directives/uiView.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** @module directives */ /** */
/** @ng2api @module directives */ /** */
import {
Component, ComponentFactoryResolver, ViewContainerRef, Input, ComponentRef, Type,
ReflectiveInjector, ViewChild, Injector, Inject
Expand Down
2 changes: 1 addition & 1 deletion src/ng2/interface.ts
Original file line number Diff line number Diff line change
@@ -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";
Expand Down
2 changes: 1 addition & 1 deletion src/ng2/lazyLoadNgModule.ts
Original file line number Diff line number Diff line change
@@ -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";
Expand Down
2 changes: 1 addition & 1 deletion src/ng2/uiRouterNgModule.ts
Original file line number Diff line number Diff line change
@@ -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";
Expand Down
35 changes: 1 addition & 34 deletions tsconfig.typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
}

0 comments on commit 0a997a9

Please sign in to comment.