[Event Hubs] Remove use of @Property tag in docs (#13637)

This PR resolves about 150 linter errors around the use of `@property` tag which is not allowed in TSDoc

Related to #12953

sdk/eventhub/event-hubs/src/connectionContext.ts

@@ -30,30 +30,30 @@ import { SharedKeyCredential } from "./eventhubSharedKeyCredential";
  */
 export interface ConnectionContext extends ConnectionContextBase {
   /**
-   * @property config The EventHub connection config that is created after
+   * The EventHub connection config that is created after
    * parsing the connection string.
    */
   readonly config: EventHubConnectionConfig;
   /**
-   * @property {SharedKeyCredential | TokenCredential} [tokenCredential] The credential to be used for Authentication.
+   * The credential to be used for Authentication.
    * Default value: SharedKeyCredentials.
    */
   tokenCredential: SharedKeyCredential | TokenCredential;
   /**
-   * @property wasConnectionCloseCalled Indicates whether the close() method was
+   * Indicates whether the close() method was
    * called on theconnection object.
    */
   wasConnectionCloseCalled: boolean;
   /**
-   * @property receivers A dictionary of the EventHub Receivers associated with this client.
+   * A dictionary of the EventHub Receivers associated with this client.
    */
   receivers: Dictionary<EventHubReceiver>;
   /**
-   * @property senders A dictionary of the EventHub Senders associated with this client.
+   * A dictionary of the EventHub Senders associated with this client.
    */
   senders: Dictionary<EventHubSender>;
   /**
-   * @property managementSession A reference to the management session ($management endpoint) on
+   * A reference to the management session ($management endpoint) on
    * the underlying amqp connection for the EventHub Client.
    */
   managementSession?: ManagementClient;
@@ -131,7 +131,7 @@ type ConnectionContextMethods = Omit<
  */
 export namespace ConnectionContext {
   /**
-   * @property userAgent The user agent string for the EventHubs client.
+   * The user agent string for the EventHubs client.
    * See guideline at https://github.com/Azure/azure-sdk/blob/master/docs/design/Telemetry.mdk
    */
   const userAgent: string = `azsdk-js-azureeventhubs/${

sdk/eventhub/event-hubs/src/dataTransformer.ts

@@ -50,7 +50,7 @@ export const defaultDataTransformer = {
   },
 
   /**
-   * @property {Function} [decode] A function that takes the body property from an AMQP message
+   * A function that takes the body property from an AMQP message
    * (an AMQP Data type (data section in rhea terms)) and returns the decoded message body.
    * If it cannot decode the body then it returns the body
    * as-is.

sdk/eventhub/event-hubs/src/eventData.ts

@@ -11,23 +11,23 @@ import { isDefined } from "./util/typeGuards";
  */
 export interface EventHubDeliveryAnnotations extends DeliveryAnnotations {
   /**
-   * @property [last_enqueued_offset] The offset of the last event.
+   * The offset of the last event.
    */
   last_enqueued_offset?: string;
   /**
-   * @property [last_enqueued_sequence_number] The sequence number of the last event.
+   * The sequence number of the last event.
    */
   last_enqueued_sequence_number?: number;
   /**
-   * @property [last_enqueued_time_utc] The enqueued time of the last event.
+   * The enqueued time of the last event.
    */
   last_enqueued_time_utc?: number;
   /**
-   * @property [runtime_info_retrieval_time_utc] The retrieval time of the last event.
+   * The retrieval time of the last event.
    */
   runtime_info_retrieval_time_utc?: number;
   /**
-   * @property Any unknown delivery annotations.
+   * Any unknown delivery annotations.
    */
   [x: string]: any;
 }
@@ -38,23 +38,23 @@ export interface EventHubDeliveryAnnotations extends DeliveryAnnotations {
  */
 export interface EventHubMessageAnnotations extends MessageAnnotations {
   /**
-   * @property [x-opt-partition-key] Annotation for the partition key set for the event.
+   * Annotation for the partition key set for the event.
    */
   "x-opt-partition-key"?: string | null;
   /**
-   * @property [x-opt-sequence-number] Annontation for the sequence number of the event.
+   * Annontation for the sequence number of the event.
    */
   "x-opt-sequence-number"?: number;
   /**
-   * @property [x-opt-enqueued-time] Annotation for the enqueued time of the event.
+   * Annotation for the enqueued time of the event.
    */
   "x-opt-enqueued-time"?: number;
   /**
-   * @property [x-opt-offset] Annotation for the offset of the event.
+   * Annotation for the offset of the event.
    */
   "x-opt-offset"?: string;
   /**
-   * @property Any other annotation that can be added to the message.
+   * Any other annotation that can be added to the message.
    */
   [x: string]: any;
 }
@@ -65,48 +65,48 @@ export interface EventHubMessageAnnotations extends MessageAnnotations {
  */
 export interface EventDataInternal {
   /**
-   * @property body - The message body that needs to be sent or is received.
+   * The message body that needs to be sent or is received.
    */
   body: any;
   /**
-   * @property [enqueuedTimeUtc] The enqueued time of the event.
+   * The enqueued time of the event.
    */
   enqueuedTimeUtc?: Date;
   /**
-   * @property [partitionKey] If specified EventHub will hash this to a partitionId.
+   * If specified EventHub will hash this to a partitionId.
    * It guarantees that messages end up in a specific partition on the event hub.
    */
   partitionKey?: string | null;
   /**
-   * @property [offset] The offset of the event.
+   * The offset of the event.
    */
   offset?: number;
   /**
-   * @property [sequenceNumber] The sequence number of the event.
+   * The sequence number of the event.
    */
   sequenceNumber?: number;
   /**
-   * @property [properties] The application specific properties.
+   * The application specific properties.
    */
   properties?: { [property: string]: any };
   /**
-   * @property [lastSequenceNumber] The last sequence number of the event within the partition stream of the Event Hub.
+   * The last sequence number of the event within the partition stream of the Event Hub.
    */
   lastSequenceNumber?: number;
   /**
-   * @property [lastEnqueuedOffset] The offset of the last enqueued event.
+   * The offset of the last enqueued event.
    */
   lastEnqueuedOffset?: string;
   /**
-   * @property [lastEnqueuedTime] The enqueued UTC time of the last event.
+   * The enqueued UTC time of the last event.
    */
   lastEnqueuedTime?: Date;
   /**
-   * @property [retrievalTime] The time when the runtime info was retrieved
+   * The time when the runtime info was retrieved
    */
   retrievalTime?: Date;
   /**
-   * @property [systemProperties] The properties set by the service.
+   * The properties set by the service.
    */
   systemProperties?: { [property: string]: any };
 }
@@ -229,14 +229,14 @@ export function toRheaMessage(data: EventData, partitionKey?: string): RheaMessa
  */
 export interface EventData {
   /**
-   * @property The message body that needs to be sent.
+   * The message body that needs to be sent.
    * If the application reading the events is not using this SDK,
    * convert your body payload to a byte array or Buffer for better
    * cross-language compatibility.
    */
   body: any;
   /**
-   * @property Set of key value pairs that can be used to set properties specific to user application.
+   * Set of key value pairs that can be used to set properties specific to user application.
    */
   properties?: {
     [key: string]: any;
@@ -250,34 +250,34 @@ export interface EventData {
  */
 export interface ReceivedEventData {
   /**
-   * @property The message body that needs to be sent or is received.
+   * The message body that needs to be sent or is received.
    */
   body: any;
   /**
-   * @property The application specific properties.
+   * The application specific properties.
    */
   properties?: {
     [key: string]: any;
   };
   /**
-   * @property The enqueued time of the event.
+   * The enqueued time of the event.
    */
   enqueuedTimeUtc: Date;
   /**
-   * @property When specified Event Hub will hash this to a partitionId.
+   * When specified Event Hub will hash this to a partitionId.
    * It guarantees that messages end up in a specific partition on the event hub.
    */
   partitionKey: string | null;
   /**
-   * @property The offset of the event.
+   * The offset of the event.
    */
   offset: number;
   /**
-   * @property The sequence number of the event.
+   * The sequence number of the event.
    */
   sequenceNumber: number;
   /**
-   * @property The properties set by the service.
+   * The properties set by the service.
    */
   systemProperties?: {
     [key: string]: any;

sdk/eventhub/event-hubs/src/eventDataBatch.ts

@@ -134,34 +134,34 @@ export interface EventDataBatch {
  */
 export class EventDataBatchImpl implements EventDataBatch {
   /**
-   * @property Describes the amqp connection context for the Client.
+   * Describes the amqp connection context for the Client.
    */
   private _context: ConnectionContext;
   /**
-   * @property The Id of the partition to which the batch is expected to be sent to.
+   * The Id of the partition to which the batch is expected to be sent to.
    * Specifying this will throw an error if the batch was created using a `paritionKey`.
    */
   private _partitionId?: string;
   /**
-   * @property A value that is hashed to produce a partition assignment.
+   * A value that is hashed to produce a partition assignment.
    * It guarantees that messages with the same partitionKey end up in the same partition.
    * Specifying this will throw an error if the batch was created using a `paritionId`.
    */
   private _partitionKey?: string;
   /**
-   * @property The maximum size allowed for the batch.
+   * The maximum size allowed for the batch.
    */
   private _maxSizeInBytes: number;
   /**
-   * @property Current size of the batch in bytes.
+   * Current size of the batch in bytes.
    */
   private _sizeInBytes: number;
   /**
-   * @property Encoded amqp messages.
+   * Encoded amqp messages.
    */
   private _encodedMessages: Buffer[] = [];
   /**
-   * @property Number of events in the batch.
+   * Number of events in the batch.
    */
   private _count: number;
   /**
@@ -198,15 +198,15 @@ export class EventDataBatchImpl implements EventDataBatch {
   }
 
   /**
-   * @property The maximum size of the batch, in bytes.
+   * The maximum size of the batch, in bytes.
    * @readonly
    */
   get maxSizeInBytes(): number {
     return this._maxSizeInBytes;
   }
 
   /**
-   * @property The partitionKey set during `EventDataBatch` creation. This value is hashed to
+   * The partitionKey set during `EventDataBatch` creation. This value is hashed to
    * produce a partition assignment when the producer is created without a `partitionId`
    * @readonly
    */
@@ -224,7 +224,7 @@ export class EventDataBatchImpl implements EventDataBatch {
   }
 
   /**
-   * @property Size of the `EventDataBatch` instance after the events added to it have been
+   * Size of the `EventDataBatch` instance after the events added to it have been
    * encoded into a single AMQP message.
    * @readonly
    */
@@ -233,7 +233,7 @@ export class EventDataBatchImpl implements EventDataBatch {
   }
 
   /**
-   * @property Number of events in the `EventDataBatch` instance.
+   * Number of events in the `EventDataBatch` instance.
    * @readonly
    */
   get count(): number {

sdk/eventhub/event-hubs/src/eventHubConsumerClientModels.ts

@@ -13,20 +13,20 @@ import { MessagingError } from "@azure/core-amqp";
  */
 export interface BasicPartitionProperties {
   /**
-   * @property The fully qualified Event Hubs namespace. This is likely to be similar to
+   * The fully qualified Event Hubs namespace. This is likely to be similar to
    * <yournamespace>.servicebus.windows.net
    */
   fullyQualifiedNamespace: string;
   /**
-   * @property The event hub name.
+   * The event hub name.
    */
   eventHubName: string;
   /**
-   * @property The consumer group name.
+   * The consumer group name.
    */
   consumerGroup: string;
   /**
-   * @property The identifier of the Event Hub partition.
+   * The identifier of the Event Hub partition.
    */
   partitionId: string;
 }
@@ -39,20 +39,20 @@ export interface BasicPartitionProperties {
  */
 export interface PartitionContext {
   /**
-   * @property The fully qualified Event Hubs namespace. This is likely to be similar to
+   * The fully qualified Event Hubs namespace. This is likely to be similar to
    * <yournamespace>.servicebus.windows.net
    */
   readonly fullyQualifiedNamespace: string;
   /**
-   * @property The event hub name.
+   * The event hub name.
    */
   readonly eventHubName: string;
   /**
-   * @property The consumer group name.
+   * The consumer group name.
    */
   readonly consumerGroup: string;
   /**
-   * @property The identifier of the Event Hub partition.
+   * The identifier of the Event Hub partition.
    */
   readonly partitionId: string;
   /**