Fix Az.ServiceBus XML Comments (#18500)

* Fix Az.ServiceBus XML Comments * Fix Az.ServiceBus XML Comments Co-authored-by: Ziyue Zheng <[email protected]>
Azure · Jun 22, 2022 · 4b7bbbb · 4b7bbbb
1 parent 16f0e7e
commit 4b7bbbb
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 44 deletions.
diff --git a/src/ServiceBus/ServiceBus/Models/PSCorrelationFilterAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSCorrelationFilterAttributes.cs
@@ -32,17 +32,8 @@ public PSCorrelationFilterAttributes()
         /// <summary>
         /// Initializes a new instance of the CorrelationFilter class.
         /// </summary>
-        /// <param name="correlationId">Identifier of the correlation.</param>
-        /// <param name="messageId">Identifier of the message.</param>
-        /// <param name="to">Address to send to.</param>
-        /// <param name="replyTo">Address of the queue to reply to.</param>
-        /// <param name="label">Application specific label.</param>
-        /// <param name="sessionId">Session identifier.</param>
-        /// <param name="replyToSessionId">Session identifier to reply
-        /// to.</param>
-        /// <param name="contentType">Content type of the message.</param>
-        /// <param name="requiresPreprocessing">Value that indicates whether
-        /// the rule action requires preprocessing.</param>
+        /// <param name="correlationFilter">Properties of
+        /// correlationFilter</param>
         public PSCorrelationFilterAttributes(Management.ServiceBus.Models.CorrelationFilter correlationFilter)
         {
             if (correlationFilter != null)

diff --git a/src/ServiceBus/ServiceBus/Models/PSNWRuleSetIpRulesAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSNWRuleSetIpRulesAttributes.cs
@@ -43,9 +43,7 @@ public static IList<PSNWRuleSetIpRulesAttributes> PSNWRuleSetIpRulesAttributesCo
         /// <summary>
         /// Initializes a new instance of the NWRuleSetIpRules class.
         /// </summary>
-        /// <param name="ipMask">IP Mask</param>
-        /// <param name="action">The IP Filter Action. Possible values include:
-        /// 'Allow'</param>
+        /// <param name="nwiprules"></param>
         public PSNWRuleSetIpRulesAttributes(NWRuleSetIpRules nwiprules)
         {
             IpMask = nwiprules.IpMask;
@@ -59,7 +57,7 @@ public PSNWRuleSetIpRulesAttributes(NWRuleSetIpRules nwiprules)
 
         /// <summary>
         /// Gets or sets the IP Filter Action. Possible values include: 'Allow'
-        /// </summary>        
+        /// </summary>
         public string Action { get; set; }
 
     }

diff --git a/src/ServiceBus/ServiceBus/Models/PSNWRuleSetVirtualNetworkRulesAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSNWRuleSetVirtualNetworkRulesAttributes.cs
@@ -32,16 +32,14 @@ public PSNWRuleSetVirtualNetworkRulesAttributes()
         /// Initializes a new instance of the NWRuleSetVirtualNetworkRules
         /// class.
         /// </summary>
-        /// <param name="subnet">Subnet properties</param>
-        /// <param name="ignoreMissingVnetServiceEndpoint">Value that indicates
-        /// whether to ignore missing VNet Service Endpoint</param>
+        /// <param name="nwVirtualNetworkRules"></param>
         public static IList<PSNWRuleSetVirtualNetworkRulesAttributes> PSNWRuleSetVirtualNetworkRulesAttributesCollection(IList<NWRuleSetVirtualNetworkRules> nwVirtualNetworkRules)
         {
             List<PSNWRuleSetVirtualNetworkRulesAttributes> VNetRules = new List<PSNWRuleSetVirtualNetworkRulesAttributes>(); 
 
             foreach (NWRuleSetVirtualNetworkRules nwRuleSetVirtualNetworkRules in nwVirtualNetworkRules)
             {
-                VNetRules.Add(new PSNWRuleSetVirtualNetworkRulesAttributes(nwRuleSetVirtualNetworkRules));                
+                VNetRules.Add(new PSNWRuleSetVirtualNetworkRulesAttributes(nwRuleSetVirtualNetworkRules));
             }
 
             return VNetRules;
@@ -65,6 +63,6 @@ public PSNWRuleSetVirtualNetworkRulesAttributes(NWRuleSetVirtualNetworkRules nwV
         /// Service Endpoint
         /// </summary>
         public bool? IgnoreMissingVnetServiceEndpoint { get; set; }
-       
+
     }
 }
diff --git a/src/ServiceBus/ServiceBus/Models/PSNetworkRuleSetAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSNetworkRuleSetAttributes.cs
@@ -35,14 +35,8 @@ public PSNetworkRuleSetAttributes()
         /// <summary>
         /// Initializes a new instance of the NetworkRuleSet class.
         /// </summary>
-        /// <param name="id">Resource Id</param>
-        /// <param name="name">Resource name</param>
-        /// <param name="type">Resource type</param>
-        /// <param name="defaultAction">Default Action for Network Rule Set.
-        /// Possible values include: 'Allow', 'Deny'</param>
-        /// <param name="VirtualNetworkRules">List VirtualNetwork Rules</param>
-        /// <param name="ipRules">List of IpRules</param>
-        public PSNetworkRuleSetAttributes(NetworkRuleSet networkRuleSet)           
+        /// <param name="networkRuleSet"></param>
+        public PSNetworkRuleSetAttributes(NetworkRuleSet networkRuleSet)
         {
             DefaultAction = networkRuleSet.DefaultAction;
             VirtualNetworkRules = PSNWRuleSetVirtualNetworkRulesAttributes.PSNWRuleSetVirtualNetworkRulesAttributesCollection(networkRuleSet.VirtualNetworkRules);

diff --git a/src/ServiceBus/ServiceBus/Models/PSRulesAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSRulesAttributes.cs
@@ -40,18 +40,7 @@ public PSRulesAttributes()
         /// <summary>
         /// Initializes a new instance of the Rule class.
         /// </summary>
-        /// <param name="id">Resource Id</param>
-        /// <param name="name">Resource name</param>
-        /// <param name="type">Resource type</param>
-        /// <param name="action">Represents the filter actions which are
-        /// allowed for the transformation of a message that have been matched
-        /// by a filter expression.</param>
-        /// <param name="filterType">Filter type that is evaluated against a
-        /// BrokeredMessage. Possible values include: 'SqlFilter',
-        /// 'CorrelationFilter'</param>
-        /// <param name="sqlFilter">Properties of sqlFilter</param>
-        /// <param name="correlationFilter">Properties of
-        /// correlationFilter</param>
+        /// <param name="rule"></param>
         public PSRulesAttributes(Rule rule)
         {
             Name = rule.Name;

diff --git a/src/ServiceBus/ServiceBus/Models/PSServiceBusMigrationConfigurationAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSServiceBusMigrationConfigurationAttributes.cs
@@ -71,6 +71,7 @@ public PSServiceBusMigrationConfigurationAttributes(MigrationConfigProperties mc
         /// Gets state in which Standard to Premium Migration is, possible
         /// values : Unknown, Reverting, Completing, Initiating, Syncing,
         /// Active
+        /// </summary>
         public string MigrationState { get; set; }
 
     }

diff --git a/src/ServiceBus/ServiceBus/Models/PSSharedAccessSignatureAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSSharedAccessSignatureAttributes.cs
@@ -30,7 +30,7 @@ public PSSharedAccessSignatureAttributes()
         /// <summary>
         /// Initializes a new instance of the SharedAccessSignature class.
         /// </summary>
-        /// <param name="SharedAccessSignature">SharedAccess Signature</param>
+        /// <param name="sharedAccessSignature">SharedAccess Signature</param>
         public PSSharedAccessSignatureAttributes(string sharedAccessSignature)
         {
             SharedAccessSignature = sharedAccessSignature.Replace("SharedAccessSignature","");

diff --git a/src/ServiceBus/ServiceBus/Models/PSSubnetAttributes.cs b/src/ServiceBus/ServiceBus/Models/PSSubnetAttributes.cs
@@ -30,17 +30,16 @@ public PSSubnetAttributes()
         /// <summary>
         /// Initializes a new instance of the Subnet class.
         /// </summary>
-        /// <param name="id">Resource ID of Virtual Network Subnet</param>
+        /// <param name="subnet">Subnet properties</param>
         public PSSubnetAttributes(Subnet subnet)
         {
             Id = subnet.Id;
         }
 
-
         /// <summary>
         /// Gets or sets resource ID of Virtual Network Subnet
         /// </summary>
         public string Id { get; set; }
-        
+
     }
 }