[Event Hubs] update docs with explicit ignores (#4073)

Azure · Jun 25, 2019 · 95d09d6 · 95d09d6
1 parent 762e03b
commit 95d09d6
Show file tree

Hide file tree

Showing 11 changed files with 21 additions and 1 deletion.
diff --git a/sdk/eventhub/event-hubs/review/event-hubs.api.md b/sdk/eventhub/event-hubs/review/event-hubs.api.md
@@ -45,7 +45,7 @@ export class EventHubClient {
     createConsumer(consumerGroup: string, partitionId: string, eventPosition: EventPosition, options?: EventHubConsumerOptions): EventHubConsumer;
     static createFromIotHubConnectionString(iothubConnectionString: string, options?: EventHubClientOptions): Promise<EventHubClient>;
     createProducer(options?: EventHubProducerOptions): EventHubProducer;
-    static defaultConsumerGroup: string;
+    static defaultConsumerGroupName: string;
     readonly eventHubName: string;
     getPartitionIds(abortSignal?: AbortSignalLike): Promise<Array<string>>;
     getPartitionProperties(partitionId: string, abortSignal?: AbortSignalLike): Promise<PartitionProperties>;

diff --git a/sdk/eventhub/event-hubs/src/batchingReceiver.ts b/sdk/eventhub/event-hubs/src/batchingReceiver.ts
@@ -25,6 +25,7 @@ import { EventPosition } from "./eventPosition";
  * @class BatchingReceiver
  * @extends EventHubReceiver
  * @internal
+ * @ignore
  */
 export class BatchingReceiver extends EventHubReceiver {
   /**

diff --git a/sdk/eventhub/event-hubs/src/connectionContext.ts b/sdk/eventhub/event-hubs/src/connectionContext.ts
@@ -22,6 +22,7 @@ import { Dictionary, OnAmqpEvent, EventContext, ConnectionEvents } from "rhea-pr
 /**
  * @interface ConnectionContext
  * @internal
+ * @ignore
  * Provides contextual information like the underlying amqp connection, cbs session, management session,
  * tokenProvider, senders, receivers, etc. about the EventHub client.
  */

diff --git a/sdk/eventhub/event-hubs/src/eventHubReceiver.ts b/sdk/eventhub/event-hubs/src/eventHubReceiver.ts
@@ -19,6 +19,9 @@ import { LinkEntity } from "./linkEntity";
 import { EventPosition, getEventPositionFilter } from "./eventPosition";
 import { AbortSignalLike, AbortError } from "@azure/abort-controller";
 
+/**
+ * @ignore
+ */
 interface CreateReceiverOptions {
   onMessage: OnAmqpEvent;
   onError: OnAmqpEvent;
@@ -31,6 +34,7 @@ interface CreateReceiverOptions {
 
 /**
  * @internal
+ * @ignore
  * Represents the approximate receiver runtime information for a logical partition of an Event Hub.
  * @interface ReceiverRuntimeInfo
  */
@@ -67,6 +71,7 @@ export type OnError = (error: MessagingError | Error) => void;
  * Describes the EventHubReceiver that will receive event data from EventHub.
  * @class EventHubReceiver
  * @internal
+ * @ignore
  */
 export class EventHubReceiver extends LinkEntity {
   /**

diff --git a/sdk/eventhub/event-hubs/src/eventHubSender.ts b/sdk/eventhub/event-hubs/src/eventHubSender.ts
@@ -31,6 +31,9 @@ import { LinkEntity } from "./linkEntity";
 import { SendOptions, EventHubProducerOptions } from "./eventHubClient";
 import { AbortSignalLike, AbortError } from "@azure/abort-controller";
 
+/**
+ * @ignore
+ */
 interface CreateSenderOptions {
   newName?: boolean;
 }
@@ -39,6 +42,7 @@ interface CreateSenderOptions {
  * Describes the EventHubSender that will send event data to EventHub.
  * @class EventHubSender
  * @internal
+ * @ignore
  */
 export class EventHubSender extends LinkEntity {
   /**

diff --git a/sdk/eventhub/event-hubs/src/eventPosition.ts b/sdk/eventhub/event-hubs/src/eventPosition.ts
@@ -6,6 +6,7 @@ import { translate, Constants, ErrorNameConditionMapper } from "@azure/core-amqp
 /**
  * Describes the options that can be set while creating an EventPosition.
  * @internal
+ * @ignore
  * @interface EventPositionOptions
  */
 export interface EventPositionOptions {

diff --git a/sdk/eventhub/event-hubs/src/linkEntity.ts b/sdk/eventhub/event-hubs/src/linkEntity.ts
@@ -33,6 +33,7 @@ export interface LinkEntityOptions {
 /**
  * Describes the base class for entities like EventHub Sender, Receiver and Management link.
  * @internal
+ * @ignore
  * @class LinkEntity
  */
 export class LinkEntity {

diff --git a/sdk/eventhub/event-hubs/src/managementClient.ts b/sdk/eventhub/event-hubs/src/managementClient.ts
@@ -71,6 +71,7 @@ export interface ManagementClientOptions {
 /**
  * @class ManagementClient
  * @internal
+ * @ignore
  * Descibes the EventHubs Management Client that talks
  * to the $management endpoint over AMQP connection.
  */

diff --git a/sdk/eventhub/event-hubs/src/streamingReceiver.ts b/sdk/eventhub/event-hubs/src/streamingReceiver.ts
@@ -82,6 +82,7 @@ export class ReceiveHandler {
  * Describes the streaming receiver where the user can receive the message
  * by providing handler functions.
  * @internal
+ * @ignore
  * @class StreamingReceiver
  * @extends EventHubReceiver
  */

diff --git a/sdk/eventhub/event-hubs/src/util/constants.ts b/sdk/eventhub/event-hubs/src/util/constants.ts
@@ -1,6 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+/**
+ * @ignore
+ */
 export const packageJsonInfo = {
   name: "@azure/event-hubs",
   version: "3.0.0-preview.1"

diff --git a/sdk/eventhub/event-hubs/src/util/error.ts b/sdk/eventhub/event-hubs/src/util/error.ts
@@ -6,6 +6,7 @@ import { ConnectionContext } from "../connectionContext";
 
 /**
  * @internal
+ * @ignore
  * Logs and throws Error if the current AMQP connection is closed.
  * @param context The ConnectionContext associated with the current AMQP connection.
  */
@@ -20,6 +21,7 @@ export function throwErrorIfConnectionClosed(context: ConnectionContext): void {
 
 /**
  * @internal
+ * @ignore
  * Logs and Throws TypeError if given parameter is undefined or null
  * @param connectionId Id of the underlying AMQP connection used for logging
  * @param parameterName Name of the parameter to check