Code comments improvements

Author: swapnil-nagar

azure-functions-nodejs-extensions-servicebus/src/constants.ts

@@ -1,4 +1,4 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License.
 
-export const version = '0.1.0';
+export const version = '0.1.0-preview';

azure-functions-nodejs-extensions-servicebus/src/grpcClientFactory.ts

@@ -6,12 +6,29 @@ import * as protoLoader from '@grpc/proto-loader';
 import path from 'path';
 
 /**
- *  Creates a gRPC client for a specified service defined in a .proto file.
- *  This function loads the .proto file, constructs the service client, and returns it.
- * @param param0 - Configuration for creating a gRPC client.
- * @param param0.protoPath - Path to the .proto file defining the gRPC service.
- * @param param0.serviceName - Name of the service to create a client for.
- * @returns A gRPC client instance for the specified service.
+ * Creates and returns a gRPC client for the specified service.
+ *
+ * @template T - The type of gRPC client to create, extends grpc.Client
+ *
+ * @param options - The configuration options for creating the gRPC client
+ * @param options.protoPath - Path to the .proto file that defines the service
+ * @param options.serviceName - Name of the service in the proto file
+ * @param options.address - The server address to connect to (e.g., "localhost:50051")
+ * @param options.credentials - gRPC channel credentials to use for secure communication (defaults to insecure)
+ * @param options.grpcMaxMessageLength - Maximum message length in bytes for both sending and receiving gRPC messages
+ * @param options.includeDirs - Additional directories to search for imported .proto files
+ *
+ * @returns A new instance of the specified gRPC client
+ *
+ * @throws {Error} When the specified service name is not found in the proto file
+ *
+ * @example
+ * const client = createGrpcClient<MyServiceClient>({
+ *   protoPath: './protos/my_service.proto',
+ *   serviceName: 'MyService',
+ *   address: 'localhost:50051',
+ *   grpcMaxMessageLength: 4 * 1024 * 1024, // 4MB
+ * });
  */
 export function createGrpcClient<T extends grpc.Client = grpc.Client>({
     protoPath,

azure-functions-nodejs-extensions-servicebus/src/servicebus/azureServiceBusMessageFactory.ts

@@ -16,8 +16,16 @@ const DEAD_LETTER_REASON_ANNOTATION = 'DeadLetterReason';
 const DEAD_LETTER_ERROR_DESCRIPTION_ANNOTATION = 'DeadLetterErrorDescription';
 
 /**
- * Factory class for creating and caching Azure Blob Storage clients
- * following Azure best practices for client reuse and lifecycle management
+ * Factory class for creating and processing Azure Service Bus messages Manager.
+ *
+ * This factory class provides methods to:
+ * - Build ServiceBusMessage instances from model binding data in Azure Functions
+ * - Convert between different message formats (AMQP, Rhea)
+ * - Extract and decode message body content with proper type handling
+ *
+ * The factory handles all necessary transformations of message properties,
+ * annotations, and content to ensure proper integration with the Azure
+ * Service Bus messaging system.
  */
 export class AzureServiceBusMessageFactory {
     /**