Fix XML documentation issues in LlvmIrVariable.cs

Copilot · grendello · Copilot · commit 6973b39d1e7b · 2025-07-11T16:29:53.000Z
- Remove duplicate XML documentation comments for LlvmIrVariableReference and LlvmIrGlobalVariable
- Add remarks sections documenting default values for WriteOptions and NumberFormat properties
- Remove accidentally added extra closing brace

Co-authored-by: grendello &lt;184788+grendello@users.noreply.github.com&gt;
diff --git a/src/Xamarin.Android.Build.Tasks/Utilities/LlvmIrGenerator/LlvmIrVariable.cs b/src/Xamarin.Android.Build.Tasks/Utilities/LlvmIrGenerator/LlvmIrVariable.cs
@@ -45,9 +45,6 @@ enum LlvmIrVariableNumberFormat
 	Decimal,
 }
 
-/// <summary>
-/// Abstract base class for LLVM IR variable references.
-/// </summary>
 /// <summary>
 /// Abstract base class for LLVM IR variable references.
 /// </summary>
@@ -122,6 +119,9 @@ abstract class LlvmIrVariable : LlvmIrVariableReference, IEquatable<LlvmIrVariab
 	/// <summary>
 	/// Gets or sets the write options that control how this variable is output in LLVM IR.
 	/// </summary>
+	/// <remarks>
+	/// Defaults to <see cref="LlvmIrVariableWriteOptions.ArrayWriteIndexComments"/>.
+	/// </remarks>
 	public LlvmIrVariableWriteOptions WriteOptions { get; set; } = LlvmIrVariableWriteOptions.ArrayWriteIndexComments;
 
 	/// <summary>
@@ -142,6 +142,9 @@ abstract class LlvmIrVariable : LlvmIrVariableReference, IEquatable<LlvmIrVariab
 	/// <summary>
 	/// Gets or sets the number format to use when writing numeric values.
 	/// </summary>
+	/// <remarks>
+	/// Defaults to <see cref="LlvmIrVariableNumberFormat.Decimal"/>.
+	/// </remarks>
 	public LlvmIrVariableNumberFormat NumberFormat { get; set; } = LlvmIrVariableNumberFormat.Decimal;
 
 	/// <summary>
@@ -351,9 +354,6 @@ protected LlvmIrStreamedArrayDataProvider (Type arrayElementType)
 	public abstract ulong GetTotalDataSize (LlvmIrModuleTarget target);
 }
 
-/// <summary>
-/// Represents a global LLVM IR variable.
-/// </summary>
 /// <summary>
 /// Represents a global LLVM IR variable.
 /// </summary>
@@ -527,7 +527,6 @@ public LlvmIrStringVariable (string name, string value, LlvmIrStringEncoding enc
 		: this (name, new StringHolder (value, encoding, comparison), options)
 	{}
 }
-}
 
 /// <summary>
 /// This is to address my dislike to have single-line variables separated by empty lines :P.
