Skip to content

[XABT] Add comprehensive XML documentation for LLVM IR generator classes #10285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 14, 2025
Merged

[XABT] Add comprehensive XML documentation for LLVM IR generator classes #10285

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e50c430
Initial plan
Copilot Jul 11, 2025
6545c29
Add documentation for core LLVM IR generator classes and enums
Copilot Jul 11, 2025
e224c9b
Add documentation for additional LLVM IR generator classes and enums
Copilot Jul 11, 2025
674f082
Add documentation for utility classes and metadata constants
Copilot Jul 11, 2025
6973b39
Fix XML documentation issues in LlvmIrVariable.cs
Copilot Jul 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Fix XML documentation issues in LlvmIrVariable.cs 
- 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 <184788+grendello@users.noreply.github.com>
  • Loading branch information
@Copilot @grendello
Copilot and grendello committed Jul 11, 2025
commit 6973b39d1e7b0df499a888678a4e8ac6a302caf6
13 changes: 6 additions & 7 deletions src/Xamarin.Android.Build.Tasks/Utilities/LlvmIrGenerator/LlvmIrVariable.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a remarks section documenting the default property value

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in 6973b39 - remarks section documenting that WriteOptions defaults to ArrayWriteIndexComments.

/// <remarks>
/// Defaults to <see cref="LlvmIrVariableWriteOptions.ArrayWriteIndexComments"/>.
/// </remarks>
public LlvmIrVariableWriteOptions WriteOptions { get; set; } = LlvmIrVariableWriteOptions.ArrayWriteIndexComments;

/// <summary>
Expand All @@ -142,6 +142,9 @@ abstract class LlvmIrVariable : LlvmIrVariableReference, IEquatable<LlvmIrVariab
/// <summary>
/// Gets or sets the number format to use when writing numeric values.
/// </summary>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a remarks section documenting the default property value

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in 6973b39 - remarks section documenting that NumberFormat defaults to Decimal.

/// <remarks>
/// Defaults to <see cref="LlvmIrVariableNumberFormat.Decimal"/>.
/// </remarks>
public LlvmIrVariableNumberFormat NumberFormat { get; set; } = LlvmIrVariableNumberFormat.Decimal;

/// <summary>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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.
Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy