Skip to content

Document TranslationResponseValue APIs - #432

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-android-translation
Open

Document TranslationResponseValue APIs#432
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-android-translation

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Refs #242

Sources

Validation

  • Parsed both changed XML files with .NET XML parsing.
  • Confirmed CRLF line endings are preserved and git diff --check is clean.
  • Confirmed the final diff changes only Android.Views.Translation XML files.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates the XML documentation for Android.Views.Translation.TranslationResponseValue and its nested Builder by replacing “To be added.” placeholders with descriptive summaries/remarks and links back to the upstream Android reference docs (per #242).

Changes:

  • Documented TranslationResponseValue.Builder.SetExtras(...), SetText(...) (both overloads), and SetTransliteration(...) (both overloads).
  • Documented TranslationResponseValue.Text and TranslationResponseValue.Transliteration properties with expanded remarks and upstream reference links.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
docs/xml/Android.Views.Translation/TranslationResponseValue+Builder.xml Replaces placeholders with detailed docs for fluent builder setters, including upstream reference links.
docs/xml/Android.Views.Translation/TranslationResponseValue.xml Replaces placeholders with detailed docs for Text and Transliteration properties, including upstream reference links.
Suppressed comments (5)

docs/xml/Android.Views.Translation/TranslationResponseValue+Builder.xml:234

  • The method documentation removed the tag; fluent setter methods elsewhere in these XML docs include it. Add a short (e.g., "This builder instance.") for consistency.
        <summary>Sets the translated text result.</summary>
        <remarks>

docs/xml/Android.Views.Translation/TranslationResponseValue+Builder.xml:274

  • The method documentation removed the tag; fluent setter methods elsewhere in these XML docs include it. Add a short (e.g., "This builder instance.") for consistency.
        <summary>Sets the translated text result.</summary>
        <remarks>

docs/xml/Android.Views.Translation/TranslationResponseValue+Builder.xml:318

  • The method documentation removed the tag; fluent setter methods elsewhere in these XML docs include it. Add a short (e.g., "This builder instance.") for consistency.
        <summary>Sets the transliteration result of the translated text.</summary>
        <remarks>

docs/xml/Android.Views.Translation/TranslationResponseValue+Builder.xml:359

  • The method documentation removed the tag; fluent setter methods elsewhere in these XML docs include it. Add a short (e.g., "This builder instance.") for consistency.
        <summary>Sets the transliteration result of the translated text.</summary>
        <remarks>

docs/xml/Android.Views.Translation/TranslationResponseValue+Builder.xml:361

  • This is the string overload of a setter, but the remark says "This returns a CharSequence..." which is both misleading (setter) and mismatched to the overload (string). Reword to describe the provided string value instead.
          <para>This returns a CharSequence representation of the transliteration of the translated text.</para>

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/xml/Android.Views.Translation/TranslationResponseValue+Builder.xml Outdated
Comment thread docs/xml/Android.Views.Translation/TranslationResponseValue+Builder.xml Outdated
Comment thread docs/xml/Android.Views.Translation/TranslationResponseValue.xml Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 14, 2026 11:02
@jonathanpeppers
jonathanpeppers enabled auto-merge (squash) August 14, 2026 11:02
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

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.

2 participants