Add XML documentation to Android.Util.Log convenience overloads - #11638
Merged
Conversation
Co-authored-by: jonathanpeppers <840039+jonathanpeppers@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add XML documentation to Android.Util.Log convenience methods
Add XML documentation to Jun 12, 2026
Android.Util.Log convenience overloads
jonathanpeppers
marked this pull request as ready for review
June 12, 2026 13:25
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds XML documentation comments to the Android.Util.Log convenience overloads (composite format string overloads and Java.Lang.Throwable-accepting overloads) so they show up properly in IDE IntelliSense and generated API docs.
Changes:
- Added
<summary>,<param>, and<returns>documentation for the convenience overloads inAndroid.Util.Log. - Added
<seealso href="...">links to the corresponding Android API reference entries. - Referenced the relevant
LogPriorityvalues in summaries via<see cref="..."/>.
LogPriority does not have a Wtf member; android.util.Log.wtf() uses the ASSERT priority constant. Update the three <see cref="LogPriority.Wtf"/> references in the Wtf convenience overloads to <see cref="LogPriority.Assert"/> and clarify in prose that this is the priority used by Log.wtf, so the generated XML doc compiles cleanly under warnings-as-errors. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
jonathanpeppers
approved these changes
Jun 12, 2026
jonathanpeppers
left a comment
jonathanpeppers
left a comment
Member
There was a problem hiding this comment.
Going to ignore the test lanes (network issues).
I will follow up to fix those in another PR shortly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The 18 public convenience methods in
Android.Util.Log(format-string andThrowable-accepting overloads) had no XML documentation comments.<summary>,<param>,<returns>, and<seealso>to all 18 methods acrossDebug,Error,Info,Verbose,Warn,Wtf, andWriteLine<summary>references the correspondingLogPriorityvalue via<see cref="..."/><seealso href="...">