Skip to content

Add XML documentation for TextWatcher event args#12047

Draft
jonathanpeppers with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-finder-add-xml-documentation
Draft

Add XML documentation for TextWatcher event args#12047
jonathanpeppers with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-finder-add-xml-documentation

Conversation

Copilot AI commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Android.Text.TextChangedEventArgs and Android.Text.AfterTextChangedEventArgs are public, user-facing types surfaced by TextView text-change events, but they had no IntelliSense documentation. This adds XML docs to the hand-written event args in ITextWatcher.cs without changing behavior or touching the internal implementor.

  • Document public event args

    • Added <summary> docs to:
      • AfterTextChangedEventArgs
      • TextChangedEventArgs
    • Clarified which TextView events each type backs.
  • Document public members

    • Added constructor <param> docs for:
      • editable
      • text
      • start
      • before
      • after
    • Added property docs for:
      • Editable
      • Text
      • Start
      • BeforeCount
      • AfterCount
  • Align with Android callback semantics

    • Documented TextChangedEventArgs in terms of TextWatcher.beforeTextChanged() / onTextChanged().
    • Documented AfterTextChangedEventArgs in terms of TextWatcher.afterTextChanged().
    • Added seealso links to the corresponding Android API docs.
  • Scope

    • Leaves TextWatcherImplementor unchanged.
    • No runtime or API shape changes; comments only.

Example of the added documentation pattern:

/// <summary>
/// Provides data for the <see cref="Android.Widget.TextView.AfterTextChanged"/> event, raised after the text has been changed.
/// </summary>
/// <seealso href="https://developer.android.com/reference/android/text/TextWatcher#afterTextChanged(android.text.Editable)">Android documentation for <c>android.text.TextWatcher.afterTextChanged</c></seealso>
public class AfterTextChangedEventArgs : EventArgs {

	/// <summary>
	/// Gets the mutable <see cref="IEditable"/> instance that was changed, or <see langword="null"/>.
	/// </summary>
	public IEditable? Editable {
		get { return editable; }
	}
}

Co-authored-by: jonathanpeppers <840039+jonathanpeppers@users.noreply.github.com>
Copilot AI changed the title [WIP] Add XML documentation to public event argument types Add XML documentation for TextWatcher event args Jul 13, 2026
Copilot AI requested a review from jonathanpeppers July 13, 2026 02:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[fix-finder] Add XML documentation to public TextChangedEventArgs and AfterTextChangedEventArgs

2 participants