From 3def08a1cf3728e3e9f07a4170d98fba60a80669 Mon Sep 17 00:00:00 2001
From: Brian Folts <brian.folts@gmail.com>
Date: Thu, 22 Sep 2016 20:27:47 -0600
Subject: [PATCH] fix(build_docs): fix doc building

---
 package.json                                  | 1 +
 spec/helpers/ambient.d.ts                     | 2 +-
 src/MiscJSDoc.ts                              | 2 +-
 src/observable/ArrayLikeObservable.ts         | 2 +-
 src/observable/ArrayObservable.ts             | 2 +-
 src/observable/BoundCallbackObservable.ts     | 2 +-
 src/observable/BoundNodeCallbackObservable.ts | 2 +-
 src/observable/DeferObservable.ts             | 2 +-
 src/observable/EmptyObservable.ts             | 2 +-
 src/observable/ErrorObservable.ts             | 2 +-
 src/observable/ForkJoinObservable.ts          | 4 ++--
 src/observable/FromEventObservable.ts         | 2 +-
 src/observable/FromEventPatternObservable.ts  | 4 ++--
 src/observable/FromObservable.ts              | 2 +-
 src/observable/GenerateObservable.ts          | 2 +-
 src/observable/IfObservable.ts                | 2 +-
 src/observable/IntervalObservable.ts          | 2 +-
 src/observable/IteratorObservable.ts          | 2 +-
 src/observable/NeverObservable.ts             | 2 +-
 src/observable/PairsObservable.ts             | 4 ++--
 src/observable/PromiseObservable.ts           | 2 +-
 src/observable/RangeObservable.ts             | 2 +-
 src/observable/ScalarObservable.ts            | 2 +-
 src/observable/SubscribeOnObservable.ts       | 2 +-
 src/observable/TimerObservable.ts             | 2 +-
 src/observable/UsingObservable.ts             | 4 ++--
 src/observable/dom/AjaxObservable.ts          | 2 +-
 src/observable/dom/WebSocketSubject.ts        | 2 +-
 tools/custom-esdoc-plugin.js                  | 6 +-----
 29 files changed, 33 insertions(+), 36 deletions(-)

diff --git a/package.json b/package.json
index d83a8a10669..34f24404886 100644
--- a/package.json
+++ b/package.json
@@ -153,6 +153,7 @@
     "coveralls": "^2.11.13",
     "cz-conventional-changelog": "^1.2.0",
     "doctoc": "^1.0.0",
+    "escape-string-regexp": "^1.0.5 ",
     "esdoc": "^0.4.7",
     "eslint": "^2.12.0",
     "fs-extra": "^0.30.0",
diff --git a/spec/helpers/ambient.d.ts b/spec/helpers/ambient.d.ts
index 3956841d802..354c8b65306 100644
--- a/spec/helpers/ambient.d.ts
+++ b/spec/helpers/ambient.d.ts
@@ -9,4 +9,4 @@ declare module 'mocha/lib/suite' {
 }
 
 declare module 'mocha/lib/test' {
-}
\ No newline at end of file
+}
diff --git a/src/MiscJSDoc.ts b/src/MiscJSDoc.ts
index d9ca775a610..fe284b86479 100644
--- a/src/MiscJSDoc.ts
+++ b/src/MiscJSDoc.ts
@@ -14,7 +14,7 @@ import './observable/dom/MiscJSDoc';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class ObservableDoc {
   /**
diff --git a/src/observable/ArrayLikeObservable.ts b/src/observable/ArrayLikeObservable.ts
index c0c46dc4771..30586975b4f 100644
--- a/src/observable/ArrayLikeObservable.ts
+++ b/src/observable/ArrayLikeObservable.ts
@@ -8,7 +8,7 @@ import { TeardownLogic } from '../Subscription';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class ArrayLikeObservable<T> extends Observable<T> {
 
diff --git a/src/observable/ArrayObservable.ts b/src/observable/ArrayObservable.ts
index eff3621af51..fb60608b3eb 100644
--- a/src/observable/ArrayObservable.ts
+++ b/src/observable/ArrayObservable.ts
@@ -9,7 +9,7 @@ import { TeardownLogic } from '../Subscription';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class ArrayObservable<T> extends Observable<T> {
 
diff --git a/src/observable/BoundCallbackObservable.ts b/src/observable/BoundCallbackObservable.ts
index b5edd4fe514..0b160385c8f 100644
--- a/src/observable/BoundCallbackObservable.ts
+++ b/src/observable/BoundCallbackObservable.ts
@@ -9,7 +9,7 @@ import { AsyncSubject } from '../AsyncSubject';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class BoundCallbackObservable<T> extends Observable<T> {
   subject: AsyncSubject<T>;
diff --git a/src/observable/BoundNodeCallbackObservable.ts b/src/observable/BoundNodeCallbackObservable.ts
index 6405abea493..efa8fae1260 100644
--- a/src/observable/BoundNodeCallbackObservable.ts
+++ b/src/observable/BoundNodeCallbackObservable.ts
@@ -9,7 +9,7 @@ import { AsyncSubject } from '../AsyncSubject';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class BoundNodeCallbackObservable<T> extends Observable<T> {
   subject: AsyncSubject<T>;
diff --git a/src/observable/DeferObservable.ts b/src/observable/DeferObservable.ts
index 8f8dcabd915..328d1a63944 100644
--- a/src/observable/DeferObservable.ts
+++ b/src/observable/DeferObservable.ts
@@ -7,7 +7,7 @@ import { OuterSubscriber } from '../OuterSubscriber';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class DeferObservable<T> extends Observable<T> {
 
diff --git a/src/observable/EmptyObservable.ts b/src/observable/EmptyObservable.ts
index be550b0a606..77596497a26 100644
--- a/src/observable/EmptyObservable.ts
+++ b/src/observable/EmptyObservable.ts
@@ -10,7 +10,7 @@ export interface DispatchArg<T> {
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class EmptyObservable<T> extends Observable<T> {
 
diff --git a/src/observable/ErrorObservable.ts b/src/observable/ErrorObservable.ts
index aa18fcf7233..b9054589811 100644
--- a/src/observable/ErrorObservable.ts
+++ b/src/observable/ErrorObservable.ts
@@ -10,7 +10,7 @@ export interface DispatchArg {
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class ErrorObservable extends Observable<any> {
 
diff --git a/src/observable/ForkJoinObservable.ts b/src/observable/ForkJoinObservable.ts
index 86c06f2464e..cdb3a393d73 100644
--- a/src/observable/ForkJoinObservable.ts
+++ b/src/observable/ForkJoinObservable.ts
@@ -11,7 +11,7 @@ import { InnerSubscriber } from '../InnerSubscriber';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class ForkJoinObservable<T> extends Observable<T> {
   constructor(private sources: Array<SubscribableOrPromise<any>>,
@@ -138,4 +138,4 @@ class ForkJoinSubscriber<T> extends OuterSubscriber<T, T> {
 
     destination.complete();
   }
-}
\ No newline at end of file
+}
diff --git a/src/observable/FromEventObservable.ts b/src/observable/FromEventObservable.ts
index a104d7eda98..da857d92783 100644
--- a/src/observable/FromEventObservable.ts
+++ b/src/observable/FromEventObservable.ts
@@ -46,7 +46,7 @@ export type SelectorMethodSignature<T> = (...args: Array<any>) => T;
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class FromEventObservable<T, R> extends Observable<T> {
 
diff --git a/src/observable/FromEventPatternObservable.ts b/src/observable/FromEventPatternObservable.ts
index a48e6f56599..fa16d1289aa 100644
--- a/src/observable/FromEventPatternObservable.ts
+++ b/src/observable/FromEventPatternObservable.ts
@@ -5,7 +5,7 @@ import { Subscriber } from '../Subscriber';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class FromEventPatternObservable<T, R> extends Observable<T> {
 
@@ -100,4 +100,4 @@ export class FromEventPatternObservable<T, R> extends Observable<T> {
       errorSubscriber.error(e);
     }
   }
-}
\ No newline at end of file
+}
diff --git a/src/observable/FromObservable.ts b/src/observable/FromObservable.ts
index 10f6bc6ee04..9c1a9314cdb 100644
--- a/src/observable/FromObservable.ts
+++ b/src/observable/FromObservable.ts
@@ -17,7 +17,7 @@ const isArrayLike = (<T>(x: any): x is ArrayLike<T> => x && typeof x.length ===
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class FromObservable<T> extends Observable<T> {
   constructor(private ish: ObservableInput<T>, private scheduler?: Scheduler) {
diff --git a/src/observable/GenerateObservable.ts b/src/observable/GenerateObservable.ts
index 8f59767e022..740e23e9b88 100644
--- a/src/observable/GenerateObservable.ts
+++ b/src/observable/GenerateObservable.ts
@@ -52,7 +52,7 @@ export interface GenerateOptions<T, S> extends GenerateBaseOptions<S> {
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class GenerateObservable<T, S> extends Observable<T> {
   constructor(private initialState: S,
diff --git a/src/observable/IfObservable.ts b/src/observable/IfObservable.ts
index 63d99f3e621..a4efb2d8bce 100644
--- a/src/observable/IfObservable.ts
+++ b/src/observable/IfObservable.ts
@@ -7,7 +7,7 @@ import { OuterSubscriber } from '../OuterSubscriber';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class IfObservable<T, R> extends Observable<T> {
 
diff --git a/src/observable/IntervalObservable.ts b/src/observable/IntervalObservable.ts
index 8abdd6962c1..e8ffd787641 100644
--- a/src/observable/IntervalObservable.ts
+++ b/src/observable/IntervalObservable.ts
@@ -7,7 +7,7 @@ import { async } from '../scheduler/async';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class IntervalObservable extends Observable<number> {
   /**
diff --git a/src/observable/IteratorObservable.ts b/src/observable/IteratorObservable.ts
index 4195965f253..49d53a42a1a 100644
--- a/src/observable/IteratorObservable.ts
+++ b/src/observable/IteratorObservable.ts
@@ -8,7 +8,7 @@ import { Subscriber } from '../Subscriber';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class IteratorObservable<T> extends Observable<T> {
   private iterator: any;
diff --git a/src/observable/NeverObservable.ts b/src/observable/NeverObservable.ts
index b0f9259d709..3aa74916655 100644
--- a/src/observable/NeverObservable.ts
+++ b/src/observable/NeverObservable.ts
@@ -5,7 +5,7 @@ import { noop } from '../util/noop';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class NeverObservable<T> extends Observable<T> {
   /**
diff --git a/src/observable/PairsObservable.ts b/src/observable/PairsObservable.ts
index ef99786b635..badd9eb7ccc 100644
--- a/src/observable/PairsObservable.ts
+++ b/src/observable/PairsObservable.ts
@@ -30,7 +30,7 @@ function dispatch<T>(state: PairsContext<T>) {
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class PairsObservable<T> extends Observable<Array<string | T>> {
   private keys: Array<string>;
@@ -91,4 +91,4 @@ export class PairsObservable<T> extends Observable<Array<string | T>> {
       subscriber.complete();
     }
   }
-}
\ No newline at end of file
+}
diff --git a/src/observable/PromiseObservable.ts b/src/observable/PromiseObservable.ts
index 9693afaa91d..747d8f56821 100644
--- a/src/observable/PromiseObservable.ts
+++ b/src/observable/PromiseObservable.ts
@@ -7,7 +7,7 @@ import { TeardownLogic } from '../Subscription';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class PromiseObservable<T> extends Observable<T> {
 
diff --git a/src/observable/RangeObservable.ts b/src/observable/RangeObservable.ts
index 3788c026d04..93a0d1e1b1d 100644
--- a/src/observable/RangeObservable.ts
+++ b/src/observable/RangeObservable.ts
@@ -6,7 +6,7 @@ import { Subscriber } from '../Subscriber';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class RangeObservable extends Observable<number> {
 
diff --git a/src/observable/ScalarObservable.ts b/src/observable/ScalarObservable.ts
index 88b8e3f02d8..5afc5af518a 100644
--- a/src/observable/ScalarObservable.ts
+++ b/src/observable/ScalarObservable.ts
@@ -6,7 +6,7 @@ import { TeardownLogic } from '../Subscription';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class ScalarObservable<T> extends Observable<T> {
   static create<T>(value: T, scheduler?: Scheduler): ScalarObservable<T> {
diff --git a/src/observable/SubscribeOnObservable.ts b/src/observable/SubscribeOnObservable.ts
index cf003c4c70b..023cbca86b5 100644
--- a/src/observable/SubscribeOnObservable.ts
+++ b/src/observable/SubscribeOnObservable.ts
@@ -13,7 +13,7 @@ export interface DispatchArg<T> {
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class SubscribeOnObservable<T> extends Observable<T> {
   static create<T>(source: Observable<T>, delay: number = 0, scheduler: Scheduler = asap): Observable<T> {
diff --git a/src/observable/TimerObservable.ts b/src/observable/TimerObservable.ts
index 12b803ab2e1..3ee6c65ff5d 100644
--- a/src/observable/TimerObservable.ts
+++ b/src/observable/TimerObservable.ts
@@ -10,7 +10,7 @@ import { Subscriber } from '../Subscriber';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class TimerObservable extends Observable<number> {
 
diff --git a/src/observable/UsingObservable.ts b/src/observable/UsingObservable.ts
index 45a5a39d130..c2688b12cd1 100644
--- a/src/observable/UsingObservable.ts
+++ b/src/observable/UsingObservable.ts
@@ -7,7 +7,7 @@ import { OuterSubscriber } from '../OuterSubscriber';
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class UsingObservable<T> extends Observable<T> {
 
@@ -54,4 +54,4 @@ class UsingSubscriber<T> extends OuterSubscriber<T, T> {
       this._error(err);
     }
   }
-}
\ No newline at end of file
+}
diff --git a/src/observable/dom/AjaxObservable.ts b/src/observable/dom/AjaxObservable.ts
index 506589ed1dc..a66655e8712 100644
--- a/src/observable/dom/AjaxObservable.ts
+++ b/src/observable/dom/AjaxObservable.ts
@@ -94,7 +94,7 @@ export function ajaxGetJSON<T>(url: string, headers?: Object): Observable<T> {
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class AjaxObservable<T> extends Observable<T> {
   /**
diff --git a/src/observable/dom/WebSocketSubject.ts b/src/observable/dom/WebSocketSubject.ts
index 8c4ba943e93..e52635e2cff 100644
--- a/src/observable/dom/WebSocketSubject.ts
+++ b/src/observable/dom/WebSocketSubject.ts
@@ -23,7 +23,7 @@ export interface WebSocketSubjectConfig {
 /**
  * We need this JSDoc comment for affecting ESDoc.
  * @extends {Ignored}
- * @hide true
+ * @ignore
  */
 export class WebSocketSubject<T> extends AnonymousSubject<T> {
 
diff --git a/tools/custom-esdoc-plugin.js b/tools/custom-esdoc-plugin.js
index 36fac63f32b..0a0f7ffd440 100644
--- a/tools/custom-esdoc-plugin.js
+++ b/tools/custom-esdoc-plugin.js
@@ -38,7 +38,6 @@ exports.onHandleTag = function onHandleTag(ev) {
     var name = getTagValue(tag, '@name');
     var isStatic = getTagValue(tag, '@static');
     var noImport = getTagValue(tag, '@noimport');
-    var isHidden = getTagValue(tag, '@hide');
     if (name) {
       tag.name = name;
     }
@@ -46,10 +45,7 @@ exports.onHandleTag = function onHandleTag(ev) {
       delete tag.importPath;
       delete tag.importStyle;
     }
-    if (isHidden) {
-      ev.data.tag[i] = {name: '', longname: ''};
-      ev.data.tag[i]['export'] = false;
-    } else if (owner) {
+    if (owner && owner === 'Observable') {
       var ownerLongname = getLongname(ev, owner);
       tag.kind = 'method';
       tag.static = false;