Skip to content

Add XML docs for Action-based Java.Lang.Thread constructors - #12265

Merged
jonathanpeppers merged 3 commits into
mainfrom
copilot/fix-finder-add-xml-documentation
Jul 30, 2026
Merged

Add XML docs for Action-based Java.Lang.Thread constructors#12265
jonathanpeppers merged 3 commits into
mainfrom
copilot/fix-finder-add-xml-documentation

Conversation

Copilot AI commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

The Java.Lang.Thread convenience constructors that accept Action were public API surface without XML docs, which left IntelliSense/API docs incomplete. This update adds constructor-level documentation for all five Action-based overloads in Thread.cs.

  • API docs: Action-based Thread overloads

    • Added /// <summary> to each Action-based constructor.
    • Added /// <param> entries for runHandler, threadName, group, and stackSize where applicable.
    • Added Android reference links via /// <seealso href="..."> using existing Mono.Android documentation style.
  • Scope

    • Documentation-only change in src/Mono.Android/Java.Lang/Thread.cs.
    • No behavioral or signature changes.
/// <summary>
/// Initializes a new <see cref="Thread"/> with the specified name that runs the specified <paramref name="runHandler"/> when started.
/// </summary>
/// <param name="runHandler">The delegate to execute on the new thread.</param>
/// <param name="threadName">The name of the new thread.</param>
/// <seealso href="https://developer.android.com/reference/java/lang/Thread#Thread(java.lang.Runnable,%20java.lang.String)">Android documentation for <c>java.lang.Thread</c></seealso>
public Thread (Action runHandler, string threadName) : this (new RunnableImplementor (runHandler), threadName) {}

Co-authored-by: jonathanpeppers <840039+jonathanpeppers@users.noreply.github.com>
Copilot AI changed the title [WIP] Add XML documentation to Java.Lang.Thread constructors Add XML docs for Action-based Java.Lang.Thread constructors Jul 30, 2026
Copilot AI requested a review from jonathanpeppers July 30, 2026 02:47
@jonathanpeppers
jonathanpeppers marked this pull request as ready for review July 30, 2026 12:42
Copilot AI review requested due to automatic review settings July 30, 2026 12:42
@jonathanpeppers jonathanpeppers added the ready-to-review This PR is ready to review/merge, I think any CI failures are just flaky (ignorable). label Jul 30, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds missing XML documentation to the Java.Lang.Thread public convenience constructors that accept a .NET Action, improving IntelliSense and generated API docs without changing behavior or signatures.

Changes:

  • Added <summary> documentation for all five Action-based Thread constructor overloads.
  • Added <param> entries for runHandler, threadName, group, and stackSize as applicable.
  • Added Android reference links via <seealso href="..."> for each overload.

Comment thread src/Mono.Android/Java.Lang/Thread.cs Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@jonathanpeppers
jonathanpeppers enabled auto-merge (squash) July 30, 2026 15:00
@jonathanpeppers
jonathanpeppers merged commit 3950c27 into main Jul 30, 2026
44 checks passed
@jonathanpeppers
jonathanpeppers deleted the copilot/fix-finder-add-xml-documentation branch July 30, 2026 17:08
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 30, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

ready-to-review This PR is ready to review/merge, I think any CI failures are just flaky (ignorable).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[fix-finder] Add XML documentation to Action-based Java.Lang.Thread constructors

4 participants