diff --git a/src/consumer.ts b/src/consumer.ts index dd4b3fa..1b5c83e 100644 --- a/src/consumer.ts +++ b/src/consumer.ts @@ -10,7 +10,7 @@ import {Private} from './utils'; const pp = new Private>(); /** - * #### class EventConsumer\ = SubEvent\> + * ### class EventConsumer\ = SubEvent\> * * Encapsulates an event object, in order to hide its methods [[emit]] and [[cancelAll]], so the event * consumer can only receive the event, but cannot emit it, or cancel other subscriptions. diff --git a/src/count.ts b/src/count.ts index e9353c0..8eda0e3 100644 --- a/src/count.ts +++ b/src/count.ts @@ -1,8 +1,6 @@ import {IEmitOptions, IEventOptions, ISubscriber, SubEvent} from './event'; /** - * @interface ISubCountChange - * @description * Represents a change in the number of subscriptions, as used with [[onCount]] event. */ export interface ISubCountChange { @@ -18,8 +16,6 @@ export interface ISubCountChange { } /** - * @interface ICountOptions - * @description * Constructor options for [[SubEventCount]] class. */ export interface ICountOptions extends IEventOptions { @@ -30,10 +26,8 @@ export interface ICountOptions extends IEventOptions { } /** - * #### class SubEventCount\ extends SubEvent\ + * ### class SubEventCount\ extends SubEvent\ * - * @class SubEventCount - * @description * Extends [[SubEvent]] with event [[onCount]], to observe the number of subscriptions. */ export class SubEventCount extends SubEvent { diff --git a/src/event.ts b/src/event.ts index c717ac1..6af4afe 100644 --- a/src/event.ts +++ b/src/event.ts @@ -32,8 +32,6 @@ export enum EmitSchedule { } /** - * @interface IEmitOptions - * @description * Options to be used with method [[emit]]. */ export interface IEmitOptions { @@ -73,8 +71,6 @@ export interface IEmitOptions { } /** - * @interface ISubContext - * @description * Subscription Context Interface, as used with [[onSubscribe]] and [[onCancel]] * notification options that can be set during [[SubEvent]] construction. */ @@ -97,8 +93,6 @@ export interface ISubContext { } /** - * @interface IEventOptions - * @description * Constructor options for [[SubEvent]] class. */ export interface IEventOptions { @@ -137,8 +131,6 @@ export interface IEventOptions { } /** - * @interface ISubOptions - * @description * Options that can be passed into method [[subscribe]]. */ export interface ISubOptions { @@ -216,7 +208,7 @@ export interface ISubscriber extends ISubContext { } /** - * #### class SubEvent\ + * ### class SubEvent\ * * @class SubEvent * @description diff --git a/src/sub.ts b/src/sub.ts index ec55176..8ca6a93 100644 --- a/src/sub.ts +++ b/src/sub.ts @@ -1,8 +1,6 @@ /** - * #### class Subscription + * ### class Subscription * - * @class Subscription - * @description * Represents an event subscription, and a safe way to cancel it. * * @see [[cancel]]