Document TranslationResponseValue APIs - #432
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
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), andSetTransliteration(...)(both overloads). - Documented
TranslationResponseValue.TextandTranslationResponseValue.Transliterationproperties 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.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
@dalexsoto review |
Refs #242
Sources
Validation
git diff --checkis clean.Android.Views.TranslationXML files.