diff --git a/zenoh-ts/src/pubsub.ts b/zenoh-ts/src/pubsub.ts index 30a061f..781aeb4 100644 --- a/zenoh-ts/src/pubsub.ts +++ b/zenoh-ts/src/pubsub.ts @@ -41,26 +41,26 @@ import { Encoding, IntoEncoding } from "./encoding"; export class Subscriber { /** - * @hidden + * @ignore */ private remote_subscriber: RemoteSubscriber; /** - * @hidden + * @ignore */ private callback_subscriber: boolean; /** Finalization registry used for cleanup on drop - * @hidden + * @ignore */ static registry: FinalizationRegistry = new FinalizationRegistry((r_subscriber: RemoteSubscriber) => r_subscriber.undeclare()); /** - * @hidden + * @ignore */ dispose() { this.undeclare(); Subscriber.registry.unregister(this); } /** - * @hidden + * @ignore */ constructor( remote_subscriber: RemoteSubscriber, @@ -107,7 +107,7 @@ export class Subscriber { * Create a new subscriber, * note : This function should never be called directly by the user * please use `declare_subscriber` on a session to create a subscriber - * @hidden + * @ignore */ static async new( remote_subscriber: RemoteSubscriber, @@ -129,7 +129,7 @@ export enum ChannelType { /** * General interface for a Handler, not to be exposed by the user - * @hidden + * @ignore */ export interface Handler { size: number; @@ -177,12 +177,12 @@ export class Publisher { private _reliability: Reliability; private _encoding: Encoding; /** Finalization registry used for cleanup on drop - * @hidden + * @ignore */ static registry: FinalizationRegistry = new FinalizationRegistry((r_publisher: RemotePublisher) => r_publisher.undeclare()); /** - * @hidden + * @ignore */ dispose() { this.undeclare(); diff --git a/zenoh-ts/src/query.ts b/zenoh-ts/src/query.ts index 6ca25b6..37623b7 100644 --- a/zenoh-ts/src/query.ts +++ b/zenoh-ts/src/query.ts @@ -44,12 +44,12 @@ export class Queryable { private _remote_queryable: RemoteQueryable; private _callback_queryable; /** Finalization registry used for cleanup on drop - * @hidden + * @ignore */ static registry: FinalizationRegistry = new FinalizationRegistry((r_queryable: RemoteQueryable) => r_queryable.undeclare()); /** - * @hidden + * @ignore */ dispose() { this.undeclare(); @@ -102,7 +102,7 @@ export class Queryable { /** * Convenience function to convert between QueryWS and Query - * @hidden + * @ignore */ export function QueryWS_to_Query( query_ws: QueryWS, @@ -450,7 +450,7 @@ export class Reply { } /** - * @hidden + * @ignore */ constructor(reply_ws: ReplyWS) { if ("Ok" in reply_ws.result) { diff --git a/zenoh-ts/src/remote_api/session.ts b/zenoh-ts/src/remote_api/session.ts index 8c8ec9b..8cfb1bc 100644 --- a/zenoh-ts/src/remote_api/session.ts +++ b/zenoh-ts/src/remote_api/session.ts @@ -46,7 +46,7 @@ export enum RemoteRecvErr { type JSONMessage = string; /** - * @hidden + * @ignore */ export type UUIDv4 = String | string; diff --git a/zenoh-ts/src/session.ts b/zenoh-ts/src/session.ts index 312c79b..1de7cfc 100644 --- a/zenoh-ts/src/session.ts +++ b/zenoh-ts/src/session.ts @@ -147,7 +147,7 @@ export class Session { // WebSocket Backend private remote_session: RemoteSession; /** Finalization registry used for cleanup on drop - * @hidden + * @ignore */ static registry: FinalizationRegistry = new FinalizationRegistry((r_session: RemoteSession) => r_session.close()); @@ -264,7 +264,7 @@ export class Session { } /** - * @hidden internal function for handlers + * @ignore internal function for handlers */ private check_handler_or_callback(handler?: FifoChannel | RingChannel | ((sample: T) => Promise)): [undefined | ((callback: T) => Promise), HandlerChannel] { @@ -570,11 +570,11 @@ export enum RecvErr { */ export class Receiver { /** - * @hidden + * @ignore */ private receiver: SimpleChannel; /** - * @hidden + * @ignore */ private constructor(receiver: SimpleChannel) { this.receiver = receiver; @@ -609,7 +609,7 @@ export class Receiver { /** * Receiver gets created by `get` call * - * @hidden Reply + * @ignore Reply */ static new(reply_tx: SimpleChannel) { return new Receiver(reply_tx);