docs(*): make module headers more consistent

src/angular.ts

@@ -1,9 +1,5 @@
-/**
- * @hidden
- * @module ng1
- */ /** */
-declare var angular;
+/** @publicapi @module ng1 */ /** */
 import * as ng_from_import from 'angular';
-const ng_from_global = angular;
-
-export const ng = ng_from_import && ng_from_import.module ? ng_from_import : ng_from_global;
+/** @hidden */ declare var angular;
+/** @hidden */ const ng_from_global = angular;
+/** @hidden */ export const ng = ng_from_import && ng_from_import.module ? ng_from_import : ng_from_global;

src/directives/stateDirectives.ts

@@ -4,10 +4,8 @@
  * These are the directives included in UI-Router for Angular 1.
  * These directives are used in templates to create viewports and link/navigate to states.
  *
- * @ng1api
- * @preferred
- * @module directives
- */ /** for typedoc */
+ * @preferred @publicapi @module directives
+ */ /** */
 import { ng as angular } from '../angular';
 import { IAugmentedJQuery, ITimeoutService, IScope, IInterpolateService } from 'angular';
 

src/directives/viewDirective.ts

@@ -1,8 +1,4 @@
-/**
- * @ng1api
- * @module directives
- */
-
+/** @publicapi @module directives */ /** */
 import {
   $QLike,
   ActiveUIView,

src/index.ts

@@ -1,8 +1,7 @@
 /**
  * Main entry point for angular 1.x build
- * @module ng1
+ * @publicapi @module ng1
  */ /** */
-
 export * from './interface';
 export * from './services';
 export * from './statebuilders/views';

src/injectables.ts

@@ -46,9 +46,7 @@
  * - [[$stateParams]]: State param values for pending Transition (deprecated)
  * - Any resolve data defined using [[Ng1StateDeclaration.resolve]]
  *
- * @ng1api
- * @preferred
- * @module injectables
+ * @preferred @publicapi @module injectables
  */ /** */
 /* tslint:disable:prefer-const */
 import { StateProvider } from './stateProvider';

src/interface.ts

@@ -1,7 +1,4 @@
-/**
- * @ng1api
- * @module ng1
- */ /** */
+/** @publicapi @module ng1 */ /** */
 import { StateDeclaration, _ViewDeclaration, IInjectable, Transition, HookResult } from '@uirouter/core';
 
 /**

src/legacy/resolveService.ts

@@ -1,4 +1,4 @@
-/** @module ng1 */ /** */
+/** @publicapi @module ng1 */ /** */
 import { StateObject, PathNode, ResolveContext, Obj, mapObj, resolvablesBuilder } from '@uirouter/core';
 import * as angular from 'angular';
 

src/legacy/stateEvents.ts

@@ -16,7 +16,7 @@
  * angular.module("myApplication", ['ui.router', 'ui.router.state.events']
  * ```
  *
- * @module ng1_state_events
+ * @publicapi @module ng1_state_events
  */ /** */
 import { ng as angular } from '../angular';
 import { IScope, IAngularEvent, IServiceProviderFactory } from 'angular';

src/locationServices.ts

@@ -1,13 +1,11 @@
-/**
- * @internalapi
- * @module ng1
- */ /** */
+/** @publicapi @module ng1 */ /** */
 import { LocationConfig, LocationServices, UIRouter, ParamType, isDefined } from '@uirouter/core';
 import { val, createProxyFunctions, removeFrom, isObject } from '@uirouter/core';
 import { ILocationService, ILocationProvider, IWindowService } from 'angular';
 
 /**
  * Implements UI-Router LocationServices and LocationConfig using Angular 1's $location service
+ * @internalapi
  */
 export class Ng1LocationServices implements LocationConfig, LocationServices {
   private $locationProvider: ILocationProvider;

src/services.ts

@@ -6,10 +6,8 @@
  *
  * The optional [[$resolve]] service is also documented here.
  *
- * @module ng1
- * @preferred
- */
-/** for typedoc */
+ * @preferred @publicapi @module ng1
+ */ /** */
 import { ng as angular } from './angular';
 import {
   IRootScopeService,

src/stateFilters.ts

@@ -1,4 +1,4 @@
-/** @module ng1 */ /** for typedoc */
+/** @publicapi @module ng1 */ /** */
 
 import { ng as angular } from './angular';
 import { Obj, StateService, StateOrName } from '@uirouter/core';

src/stateProvider.ts

@@ -1,4 +1,4 @@
-/** @module ng1 */ /** for typedoc */
+/** @publicapi @module ng1 */ /** */
 import {
   val,
   isObject,

src/statebuilders/onEnterExitRetain.ts

@@ -1,4 +1,4 @@
-/** @module ng1 */ /** */
+/** @publicapi @module ng1 */ /** */
 import {
   StateObject,
   TransitionStateHookFn,
@@ -18,6 +18,8 @@ import { Ng1StateDeclaration } from '../interface';
  *
  * When the [[StateBuilder]] builds a [[StateObject]] object from a raw [[StateDeclaration]], this builder
  * ensures that those hooks are injectable for @uirouter/angularjs (ng1).
+ *
+ * @internalapi
  */
 export const getStateHookBuilder = (hookName: 'onEnter' | 'onExit' | 'onRetain') =>
   function stateHookBuilder(stateObject: StateObject, parentFn: BuilderFunction): TransitionStateHookFn {

src/statebuilders/views.ts

@@ -1,4 +1,4 @@
-/** @module ng1 */ /** */
+/** @publicapi @module ng1 */ /** */
 import { ng as angular } from '../angular';
 import {
   StateObject,
@@ -24,6 +24,7 @@ import { Ng1ViewDeclaration } from '../interface';
 import { TemplateFactory } from '../templateFactory';
 import IInjectorService = angular.auto.IInjectorService;
 
+/** @internalapi */
 export function getNg1ViewConfigFactory(): ViewConfigFactory {
   let templateFactory: TemplateFactory = null;
   return (path, view) => {
@@ -32,6 +33,7 @@ export function getNg1ViewConfigFactory(): ViewConfigFactory {
   };
 }
 
+/** @internalapi */
 const hasAnyKey = (keys, obj) => keys.reduce((acc, key) => acc || isDefined(obj[key]), false);
 
 /**
@@ -42,6 +44,8 @@ const hasAnyKey = (keys, obj) => keys.reduce((acc, key) => acc || isDefined(obj[
  *
  * If no `views: {}` property exists on the [[StateDeclaration]], then it creates the `views` object
  * and applies the state-level configuration to a view named `$default`.
+ *
+ * @internalapi
  */
 export function ng1ViewsBuilder(state: StateObject) {
   // Do not process root state
@@ -98,7 +102,10 @@ export function ng1ViewsBuilder(state: StateObject) {
   return views;
 }
 
+/** @hidden */
 let id = 0;
+
+/** @internalapi */
 export class Ng1ViewConfig implements ViewConfig {
   $id = id++;
   loaded = false;

src/templateFactory.ts

@@ -1,5 +1,4 @@
-/** @module view */
-/** for typedoc */
+/** @publicapi @module view */ /** */
 import { ng as angular } from './angular';
 import { IAugmentedJQuery } from 'angular';
 import {

src/urlRouterProvider.ts

@@ -1,4 +1,4 @@
-/** @module url */ /** */
+/** @publicapi @module url */ /** */
 import {
   UIRouter,
   LocationServices,
@@ -27,6 +27,7 @@ export interface RawNg1RuleFunction {
  *
  * This provider remains for backwards compatibility.
  *
+ * @internalapi
  * @deprecated
  */
 export class UrlRouterProvider {

src/viewScroll.ts

@@ -1,4 +1,4 @@
-/** @module ng1 */ /** */
+/** @publicapi @module ng1 */ /** */
 import { ng as angular } from './angular';
 import { IServiceProviderFactory } from 'angular';
 import IAnchorScrollService = angular.IAnchorScrollService;

typedoc.json

@@ -25,8 +25,8 @@
       "name": "@uirouter/angularjs",
       "theme": "node_modules/ui-router-typedoc-themes/bin/default",
       "out": "_doc",
-      "internal-aliases": "internal,coreapi,ng1api",
-      "external-aliases": "internalapi,external",
+      "internal-aliases": "internal,publicapi,publicapi",
+      "external-aliases": "external,internalapi",
       "navigation-label-globals": "@uirouter/angularjs"
     }
   }