docs(reference): hide irrelevant Observable subclasses

Transient Observables like ErrorObservable are made hidden by this commit. This cleans up the
documentation in Observable listing all its subclasses. Transient Observable subclasses are
irrelevant in the documentation since they cannot be directly used by the API.

src/Subject.ts

@@ -9,6 +9,9 @@ import {$$rxSubscriber} from './symbol/rxSubscriber';
 import {throwError} from './util/throwError';
 import {ObjectUnsubscribedError} from './util/ObjectUnsubscribedError';
 
+/**
+ * @class Subject<T>
+ */
 export class Subject<T> extends Observable<T> implements Observer<T>, Subscription {
 
   static create: Function = <T>(destination: Observer<T>, source: Observable<T>): Subject<T> => {
@@ -221,6 +224,11 @@ export class Subject<T> extends Observable<T> implements Observer<T>, Subscripti
   }
 }
 
+/**
+ * We need this JSDoc comment for affecting ESDoc.
+ * @ignore
+ * @extends {Ignored}
+ */
 class SubjectObservable<T> extends Observable<T> {
   constructor(source: Subject<T>) {
     super();

src/observable/ArrayLikeObservable.ts

@@ -5,6 +5,11 @@ import {EmptyObservable} from './EmptyObservable';
 import {Subscriber} from '../Subscriber';
 import {Subscription} from '../Subscription';
 
+/**
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
+ */
 export class ArrayLikeObservable<T> extends Observable<T> {
 
   private mapFn: (x: T, y: number) => T;

src/observable/ArrayObservable.ts

@@ -7,19 +7,21 @@ import {isScheduler} from '../util/isScheduler';
 import {Subscription} from '../Subscription';
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class ArrayObservable<T> extends Observable<T> {
 
   /**
    * @param array
    * @param scheduler
-   * @return {ArrayObservable}
+   * @return {Observable}
    * @static true
    * @name fromArray
    * @owner Observable
    */
-  static create<T>(array: T[], scheduler?: Scheduler) {
+  static create<T>(array: T[], scheduler?: Scheduler): Observable<T> {
     return new ArrayObservable(array, scheduler);
   }
 

src/observable/BoundCallbackObservable.ts

@@ -7,7 +7,9 @@ import {errorObject} from '../util/errorObject';
 import {AsyncSubject} from '../subject/AsyncSubject';
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class BoundCallbackObservable<T> extends Observable<T> {
   subject: AsyncSubject<T>;

src/observable/BoundNodeCallbackObservable.ts

@@ -7,7 +7,9 @@ import {errorObject} from '../util/errorObject';
 import {AsyncSubject} from '../subject/AsyncSubject';
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class BoundNodeCallbackObservable<T> extends Observable<T> {
   subject: AsyncSubject<T>;

src/observable/ConnectableObservable.ts

@@ -3,6 +3,9 @@ import {Observable} from '../Observable';
 import {Subscriber} from '../Subscriber';
 import {Subscription} from '../Subscription';
 
+/**
+ * @class ConnectableObservable<T>
+ */
 export class ConnectableObservable<T> extends Observable<T> {
 
   protected subject: Subject<T>;
@@ -62,6 +65,11 @@ class ConnectableSubscription extends Subscription {
   }
 }
 
+/**
+ * We need this JSDoc comment for affecting ESDoc.
+ * @ignore
+ * @extends {Ignored}
+ */
 class RefCountObservable<T> extends Observable<T> {
   connection: Subscription;
 

src/observable/DeferObservable.ts

@@ -4,7 +4,9 @@ import {tryCatch} from '../util/tryCatch';
 import {errorObject} from '../util/errorObject';
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class DeferObservable<T> extends Observable<T> {
 

src/observable/EmptyObservable.ts

@@ -4,13 +4,15 @@ import {Observable} from '../Observable';
 import {Subscription} from '../Subscription';
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class EmptyObservable<T> extends Observable<T> {
 
   /**
    * @param scheduler
-   * @return {EmptyObservable<T>}
+   * @return {Observable<T>}
    * @static true
    * @name empty
    * @owner Observable

src/observable/ErrorObservable.ts

@@ -3,7 +3,9 @@ import {Observable} from '../Observable';
 import {Subscription} from '../Subscription';
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class ErrorObservable extends Observable<any> {
 

src/observable/ForkJoinObservable.ts

@@ -6,7 +6,9 @@ import {isPromise} from '../util/isPromise';
 import {isArray} from '../util/isArray';
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class ForkJoinObservable<T> extends Observable<T> {
   constructor(private sources: Array<Observable<any> | Promise<any>>,

src/observable/FromEventObservable.ts

@@ -35,7 +35,9 @@ function isEventTarget(sourceObj: any): sourceObj is EventTarget {
 export type EventTargetLike = EventTarget | NodeStyleEventEmmitter | JQueryStyleEventEmitter | NodeList | HTMLCollection;
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class FromEventObservable<T, R> extends Observable<T> {
 

src/observable/FromEventPatternObservable.ts

@@ -5,7 +5,9 @@ import {errorObject} from '../util/errorObject';
 import {Subscriber} from '../Subscriber';
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class FromEventPatternObservable<T, R> extends Observable<T> {
 

src/observable/FromObservable.ts

@@ -17,7 +17,9 @@ import {ObserveOnSubscriber} from '../operator/observeOn';
 const isArrayLike = (<T>(x: any): x is ArrayLike<T> => x && typeof x.length === 'number');
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class FromObservable<T> extends Observable<T> {
   constructor(private ish: ObservableInput<T>, private scheduler: Scheduler) {

src/observable/IfObservable.ts

@@ -2,6 +2,11 @@ import {Observable} from '../Observable';
 import {Subscriber} from '../Subscriber';
 import {Subscription} from '../Subscription';
 
+/**
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
+ */
 export class IfObservable<T, R> extends Observable<T> {
 
   static create<T, R>(condition: () => boolean,

src/observable/IntervalObservable.ts

@@ -5,7 +5,9 @@ import {Observable} from '../Observable';
 import {async} from '../scheduler/async';
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class IntervalObservable extends Observable<number> {
   /**

src/observable/IteratorObservable.ts

@@ -9,6 +9,11 @@ import {errorObject} from '../util/errorObject';
 import {Subscription} from '../Subscription';
 import {Subscriber} from '../Subscriber';
 
+/**
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
+ */
 export class IteratorObservable<T> extends Observable<T> {
   private iterator: any;
 

src/observable/NeverObservable.ts

@@ -3,7 +3,9 @@ import {Subscriber} from '../Subscriber';
 import {noop} from '../util/noop';
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class NeverObservable<T> extends Observable<T> {
   /**

src/observable/PromiseObservable.ts

@@ -5,7 +5,9 @@ import {Subscriber} from '../Subscriber';
 import {Subscription} from '../Subscription';
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class PromiseObservable<T> extends Observable<T> {
 

src/observable/RangeObservable.ts

@@ -4,7 +4,9 @@ import {Subscription} from '../Subscription';
 import {Subscriber} from '../Subscriber';
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class RangeObservable extends Observable<number> {
 

src/observable/ScalarObservable.ts

@@ -3,6 +3,11 @@ import {Observable} from '../Observable';
 import {Subscriber} from '../Subscriber';
 import {Subscription} from '../Subscription';
 
+/**
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
+ */
 export class ScalarObservable<T> extends Observable<T> {
   static create<T>(value: T, scheduler?: Scheduler): ScalarObservable<T> {
     return new ScalarObservable(value, scheduler);

src/observable/SubscribeOnObservable.ts

@@ -5,6 +5,11 @@ import {Observable} from '../Observable';
 import {asap} from '../scheduler/asap';
 import {isNumeric} from '../util/isNumeric';
 
+/**
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
+ */
 export class SubscribeOnObservable<T> extends Observable<T> {
   static create<T>(source: Observable<T>, delay: number = 0, scheduler: Scheduler = asap): Observable<T> {
     return new SubscribeOnObservable(source, delay, scheduler);

src/observable/TimerObservable.ts

@@ -8,7 +8,9 @@ import {Subscription} from '../Subscription';
 import {Subscriber} from '../Subscriber';
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class TimerObservable extends Observable<number> {
 

src/observable/UsingObservable.ts

@@ -2,6 +2,11 @@ import {Observable} from '../Observable';
 import {Subscriber} from '../Subscriber';
 import {Subscription} from '../Subscription';
 
+/**
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
+ */
 export class UsingObservable<T> extends Observable<T> {
 
   static create<T>(resourceFactory: () => Subscription,

src/observable/dom/AjaxObservable.ts

@@ -71,28 +71,41 @@ export function ajaxGetJSON<T, R>(url: string, resultSelector?: (data: T) => R,
   const finalResultSelector = resultSelector ? (res: AjaxResponse) => resultSelector(res.response) : (res: AjaxResponse) => res.response;
   return new AjaxObservable<R>({ method: 'GET', url, responseType: 'json', resultSelector: finalResultSelector, headers });
 };
+
+/**
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
+ */
+export class AjaxObservable<T> extends Observable<T> {
   /**
-   * Creates an observable for an Ajax request with either a request object with url, headers, etc or a string for a URL.
+   * Creates an observable for an Ajax request with either a request object with
+   * url, headers, etc or a string for a URL.
    *
    * @example
-   *   source = Rx.Observable.ajax('/products');
-   *   source = Rx.Observable.ajax( url: 'products', method: 'GET' });
-   *
-   * @param {Object} request Can be one of the following:
+   * source = Rx.Observable.ajax('/products');
+   * source = Rx.Observable.ajax( url: 'products', method: 'GET' });
    *
-   *  A string of the URL to make the Ajax call.
-   *  An object with the following properties
+   * @param {string|Object} request Can be one of the following:
+   *   A string of the URL to make the Ajax call.
+   *   An object with the following properties
    *   - url: URL of the request
    *   - body: The body of the request
    *   - method: Method of the request, such as GET, POST, PUT, PATCH, DELETE
    *   - async: Whether the request is async
    *   - headers: Optional headers
    *   - crossDomain: true if a cross domain request, else false
-   *   - createXHR: a function to override if you need to use an alternate XMLHttpRequest implementation.
-   *   - resultSelector: a function to use to alter the output value type of the Observable. Gets {AjaxResponse} as an argument
+   *   - createXHR: a function to override if you need to use an alternate
+   *   XMLHttpRequest implementation.
+   *   - resultSelector: a function to use to alter the output value type of
+   *   the Observable. Gets {@link AjaxResponse} as an argument.
    * @return {Observable} An observable sequence containing the XMLHttpRequest.
+   * @static true
+   * @name ajax
+   * @owner Observable
   */
-export class AjaxObservable<T> extends Observable<T> {
+  static _create_stub(): void { return null; }
+
   static create: AjaxCreationMethod = (() => {
     const create: any = (urlOrRequest: string | AjaxRequest) => {
       return new AjaxObservable(urlOrRequest);

src/observable/dom/WebSocketSubject.ts

@@ -21,7 +21,9 @@ export interface WebSocketSubjectConfig {
 }
 
 /**
- *
+ * We need this JSDoc comment for affecting ESDoc.
+ * @extends {Ignored}
+ * @hide true
  */
 export class WebSocketSubject<T> extends Subject<T> {
   url: string;

src/operator/delayWhen.ts

@@ -114,6 +114,11 @@ class DelayWhenSubscriber<T, R> extends OuterSubscriber<T, R> {
   }
 }
 
+/**
+ * We need this JSDoc comment for affecting ESDoc.
+ * @ignore
+ * @extends {Ignored}
+ */
 class SubscriptionDelayObservable<T> extends Observable<T> {
   constructor(protected source: Observable<T>, private subscriptionDelay: Observable<any>) {
     super();