docs(*): make module headers more consistent

Author: christopherthielen

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,