Add enhanced XML documentation to MPG generator operation methods

[Copilot]

Add Enhanced Documentation to MPG Generator

Summary

Added detailed XML documentation to operation methods in the Azure Management Plane Generator (MPG), including Request Path, Operation Id, Default Api Version, and Resource information using structured XmlDocStatement objects.

Implementation

• Created BuildEnhancedXmlDocs method in ResourceOperationMethodProvider
• Uses XmlDocStatement API to construct structured XML documentation
• Builds list with items for metadata (Request Path, Operation Id, API Version, Resource)
• Updates XmlDocs with XmlDocSummaryStatement for proper XML rendering
• Builds and compiles successfully
• All required information is included in documentation
• Merged latest main branch and resolved conflicts
• Regenerated test projects with proper XML documentation
• Removed dead code and simplified implementation

Approach

The implementation uses the XmlDocStatement API from the TypeSpec generator to build structured XML documentation instead of raw FormattableString content. This ensures XML tags are rendered properly without HTML encoding issues.

Code Structure:

1. Creates individual XmlDocStatement objects for each list item (<item>, <term>, <description>)
2. Wraps items in a list statement with <list type="bullet"> tags
3. Combines base description with list in an XmlDocSummaryStatement
4. Updates the method's XmlDocs with the structured summary via existingXmlDocs.Update(summary: summaryStatement)

This approach matches the pattern used in PropertyDescriptionBuilder.cs from the TypeSpec generator and ensures proper XML rendering in the generated code.

Generated Output

The generated documentation now properly renders XML tags:

/// <summary>
/// Get a Bar
/// <list type="bullet">
/// <item>
/// <term> Request Path. </term>
/// <description> /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/MgmtTypeSpec/foos/{fooName}/bars/{barName}. </description>
/// </item>
/// <item>
/// <term> Operation Id. </term>
/// <description> Get. </description>
/// </item>
/// <item>
/// <term> Default Api Version. </term>
/// <description> 2024-05-01. </description>
/// </item>
/// <item>
/// <term> Resource. </term>
/// <description> <see cref="BarResource"/>. </description>
/// </item>
/// </list>
/// </summary>

Fixes #53219

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Some documentation missing in new MPG generator</issue_title>
<issue_description>The expected summary is

azure-sdk-for-net/sdk/batch/Azure.ResourceManager.Batch/src/Generated/BatchAccountPoolResource.cs

Lines 92 to 112 in e11a233

	/// <summary>
	/// Gets information about the specified pool.
	/// <list type="bullet">
	/// <item>
	/// <term>Request Path</term>
	/// <description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}</description>
	/// </item>
	/// <item>
	/// <term>Operation Id</term>
	/// <description>Pool_Get</description>
	/// </item>
	/// <item>
	/// <term>Default Api Version</term>
	/// <description>2024-07-01</description>
	/// </item>
	/// <item>
	/// <term>Resource</term>
	/// <description><see cref="BatchAccountPoolResource"/></description>
	/// </item>
	/// </list>
	/// </summary>

The corresponding description population logic is https://github.com/Azure/autorest.csharp/blob/d93297d16162903b0f2647f890a5db99535e2009/src/AutoRest.CSharp/Mgmt/Models/MgmtClientOperation.cs#L138-L196

The current summary is

azure-sdk-for-net/eng/packages/http-client-csharp-mgmt/generator/TestProjects/Local/Mgmt-TypeSpec/src/Generated/BarResource.cs

Line 105 in e11a233

/// <summary> Delete a Bar. </summary>

Update Azure.Generator.Management to generate expected description.</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #53219

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[live1206]

@copilot merge latest main branch and resolve the conflicts.
regenerate the test project to reflect the latest generator change.

[Copilot]

@copilot merge latest main branch and resolve the conflicts.
regenerate the test project to reflect the latest generator change.

Merged latest main branch and regenerated test projects. The merge had one conflict in FooResource.cs which was resolved by accepting the main version and regenerating. All test projects now reflect the updated generator with proper XML documentation using XmlDocStatement construction.

The generated documentation now correctly shows XML tags without HTML encoding:

• <list type="bullet"> instead of <list type="bullet">
• Proper <item>, <term>, <description> tags
• All operation metadata included (Request Path, Operation Id, API Version, Resource)

Commits:

• ed55ee7: Merge main branch
• 86836c3: Regenerate test projects with proper XML documentation

[Copilot]

Pull Request Overview

Adds enhanced XML documentation to Azure Management Plane Generator operation methods, including Request Path, Operation Id, Default Api Version, and Resource information using structured XmlDocStatement objects for proper XML rendering.

• Implements BuildEnhancedXmlDocs method using structured XmlDocStatement API instead of raw strings
• Updates operation method documentation with metadata in a bulleted list format
• Calls BuildEnhancedXmlDocs during implicit conversion to MethodProvider to apply documentation

[live1206]

/check-enforcer override