[Azure Mgmt Generator] Add XML documentation for resource client and resource collection client with TODO placeholders for parent resource info (#51861)

Co-authored-by: ArcturusZhang <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: Dapeng Zhang <[email protected]>

Author: 3 people

eng/packages/http-client-csharp-mgmt/generator/Azure.Generator.Management/src/Providers/ResourceClientProvider.cs

@@ -86,6 +86,9 @@ private ResourceClientProvider(string resourceName, InputModelType model, Resour
 
         protected override string BuildName() => ResourceName.EndsWith("Resource") ? ResourceName : $"{ResourceName}Resource";
 
+        // TODO: Add support for getting parent resource from a resource
+        protected override FormattableString BuildDescription() => $"A class representing a {ResourceName} along with the instance operations that can be performed on it. If you have a {typeof(ResourceIdentifier):C} you can construct a {Type:C} from an instance of {typeof(ArmClient):C} using the GetResource method. Otherwise you can get one from its parent resource (TODO: add parent resource information).";
+
         private OperationSourceProvider? _source;
         internal OperationSourceProvider Source => _source ??= new OperationSourceProvider(this);
 

eng/packages/http-client-csharp-mgmt/generator/Azure.Generator.Management/src/Providers/ResourceCollectionClientProvider.cs

@@ -10,6 +10,7 @@
 using Azure.Generator.Management.Utilities;
 using Azure.ResourceManager;
 using Azure.ResourceManager.Resources;
+using Humanizer;
 using Microsoft.TypeSpec.Generator.Input;
 using Microsoft.TypeSpec.Generator.Input.Extensions;
 using Microsoft.TypeSpec.Generator.Primitives;
@@ -109,6 +110,9 @@ private static void InitializeMethods(
 
         protected override string BuildName() => $"{ResourceName}Collection";
 
+        // TODO: Add support for getting parent resource from a resource collection
+        protected override FormattableString BuildDescription() => $"A class representing a collection of {_resource.Type:C} and their operations. Each {_resource.Type:C} in the collection will belong to the same instance of a parent resource (TODO: add parent resource information). To get a {Type:C} instance call the Get{ResourceName.Pluralize()} method from an instance of the parent resource.";
+
         protected override string BuildRelativeFilePath() => Path.Combine("src", "Generated", $"{Name}.cs");
 
         protected override CSharpType? BuildBaseType() => typeof(ArmCollection);